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