#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License (the "License").
# You may not use this file except in compliance with the License.
#
# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
# See the License for the specific language governing permissions
# and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information: Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#
# Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved.
#
The manpage and the HTML documentation is generated using Sphinx -
sphinx-doc.org. The last Oracle approved (TPNO 18268) version is 1.2.2.
The tool is not delivered as part of Solaris, so there's no way to generate
this automatically on build server(s), therefore whenever one is updating the
library, the documentation should be manually re-generated and the resulting
files added here.
The 'html' subdirectory is added as generated.
The jansson.3lib in 'man3lib' subdirectory needed to be manually modified after
generation so that Solaris nroff(1) is able to read it (GNU nroff is needed
otherwise).
Because we deliver the header files to /usr/include/jansson, it's necessary to
make sure the examples in the manpage and HTML documentation are correct when
updating the library.