components/jansson/doc/README
author John Beck <John.Beck@Oracle.COM>
Fri, 06 Mar 2015 13:23:54 -0800
changeset 3918 d8138667d338
parent 2190 0e3f360be1b9
permissions -rw-r--r--
20663199 six Userland components need work for Python 2.6 -> 2.7 move
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2190
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
     1
#
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
     2
# CDDL HEADER START
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
     3
#
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
     4
# The contents of this file are subject to the terms of the
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
     5
# Common Development and Distribution License (the "License").
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
     6
# You may not use this file except in compliance with the License.
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
     7
#
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
     8
# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
     9
# or http://www.opensolaris.org/os/licensing.
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    10
# See the License for the specific language governing permissions
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    11
# and limitations under the License.
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    12
#
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    13
# When distributing Covered Code, include this CDDL HEADER in each
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    14
# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    15
# If applicable, add the following below this CDDL HEADER, with the
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    16
# fields enclosed by brackets "[]" replaced with your own identifying
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    17
# information: Portions Copyright [yyyy] [name of copyright owner]
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    18
#
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    19
# CDDL HEADER END
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    20
#
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    21
# Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    22
#
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    23
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    24
The manpage and the HTML documentation is generated using Sphinx -
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    25
sphinx-doc.org. The last Oracle approved (TPNO 18268) version is 1.2.2.
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    26
The tool is not delivered as part of Solaris, so there's no way to generate
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    27
this automatically on build server(s), therefore whenever one is updating the
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    28
library, the documentation should be manually re-generated and the resulting
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    29
files added here.
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    30
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    31
The 'html' subdirectory is added as generated.
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    32
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    33
The jansson.3lib in 'man3lib' subdirectory needed to be manually modified after
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    34
generation so that Solaris nroff(1) is able to read it (GNU nroff is needed
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    35
otherwise).
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    36
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    37
Because we deliver the header files to /usr/include/jansson, it's necessary to
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    38
make sure the examples in the manpage and HTML documentation are correct when
0e3f360be1b9 PSARC/2014/362 Jansson
Tomas Heran <tomas.heran@oracle.com>
parents:
diff changeset
    39
updating the library.