4141
|
1 |
#
|
|
2 |
# CDDL HEADER START
|
|
3 |
#
|
|
4 |
# The contents of this file are subject to the terms of the
|
|
5 |
# Common Development and Distribution License (the "License").
|
|
6 |
# You may not use this file except in compliance with the License.
|
|
7 |
#
|
|
8 |
# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
|
|
9 |
# or http://www.opensolaris.org/os/licensing.
|
|
10 |
# See the License for the specific language governing permissions
|
|
11 |
# and limitations under the License.
|
|
12 |
#
|
|
13 |
# When distributing Covered Code, include this CDDL HEADER in each
|
|
14 |
# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
|
|
15 |
# If applicable, add the following below this CDDL HEADER, with the
|
|
16 |
# fields enclosed by brackets "[]" replaced with your own identifying
|
|
17 |
# information: Portions Copyright [yyyy] [name of copyright owner]
|
|
18 |
#
|
|
19 |
# CDDL HEADER END
|
|
20 |
#
|
|
21 |
# Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved.
|
|
22 |
#
|
|
23 |
|
|
24 |
The manpage and the HTML documentation is generated using Sphinx -
|
|
25 |
sphinx-doc.org. The last Oracle approved (TPNO 18268) version is 1.2.2.
|
|
26 |
The tool is not delivered as part of Solaris, so there's no way to generate
|
|
27 |
this automatically on build server(s), therefore whenever one is updating the
|
|
28 |
library, the documentation should be manually re-generated and the resulting
|
|
29 |
files added here.
|
|
30 |
|
|
31 |
The 'html' subdirectory is added as generated.
|
|
32 |
|
|
33 |
The jansson.3lib in 'man3lib' subdirectory needed to be manually modified after
|
|
34 |
generation so that Solaris nroff(1) is able to read it (GNU nroff is needed
|
|
35 |
otherwise).
|
|
36 |
|
|
37 |
Because we deliver the header files to /usr/include/jansson, it's necessary to
|
|
38 |
make sure the examples in the manpage and HTML documentation are correct when
|
|
39 |
updating the library.
|