| Name | Date | Size | |
|---|---|---|---|
| .. | 2016-12-01 22:49:49 | 9 | |
| actions.rst | 2012-05-08 22:21:55 | 6.7 KiB | |
| actions.txt | 2012-05-08 22:21:55 | 5.6 KiB | |
| apt.txt | 2012-05-08 22:21:55 | 654 | |
| boot_environments.txt | 2016-02-26 14:05:21 | 1.4 KiB | |
| case-outline.txt | 2012-05-08 22:21:55 | 717 | |
| catalog-v1.txt | 2012-05-08 22:21:55 | 48.7 KiB | |
| catalog.txt | 2012-05-08 22:21:55 | 3.6 KiB | |
| client_api_versions.txt | 2016-05-13 00:03:59 | 56.2 KiB | |
| deduction.txt | 2012-05-08 22:21:55 | 786 | |
| depot.rst | 2012-05-08 22:21:55 | 1.5 KiB | |
| depot.txt | 2012-05-08 22:21:55 | 17 KiB | |
| dev-guide | 2016-08-02 17:04:53 | 26 | |
| directory_perms.txt | 2012-05-08 22:21:55 | 2.5 KiB | |
| elf-jar-handling.txt | 2012-05-08 22:21:55 | 1.7 KiB | |
| es-requirements.txt | 2012-05-08 22:21:55 | 1.3 KiB | |
| facets.txt | 2016-08-02 17:04:53 | 5.2 KiB | |
| file-metadata.txt | 2012-05-08 22:21:55 | 1.8 KiB | |
| filter.txt | 2012-05-08 22:21:55 | 1.7 KiB | |
| guide-basic-ops.rst | 2012-05-08 22:21:55 | 6.8 KiB | |
| guide-implementation-depot.rst | 2012-05-08 22:21:55 | 3.9 KiB | |
| guide-main.rst | 2012-05-08 22:21:55 | 28.8 KiB | |
| guide-metadata-conventions.rst | 2012-05-08 22:21:55 | 10.7 KiB | |
| guide-naming-conventions.rst | 2012-09-04 00:07:50 | 7.1 KiB | |
| guide-pkg-states.rst | 2012-05-08 22:21:55 | 3.6 KiB | |
| guide-publication-protocol.rst | 2012-05-08 22:21:55 | 3.8 KiB | |
| guide-repository-format.rst | 2012-05-08 22:21:55 | 3.7 KiB | |
| guide-retrieval-protocol.rst | 2012-05-08 22:21:55 | 8 KiB | |
| guide-txn-states.rst | 2012-05-08 22:21:55 | 4.2 KiB | |
| history.txt | 2016-02-26 14:05:21 | 8.8 KiB | |
| image.rst | 2012-05-08 22:21:55 | 7.3 KiB | |
| image.txt | 2012-05-08 22:21:55 | 6.4 KiB | |
| license.txt | 2016-02-26 14:05:21 | 20.8 KiB | |
| linked-images.txt | 2016-02-26 14:05:21 | 52.6 KiB | |
| macros.rst | 2012-05-08 22:21:55 | 1.6 KiB | |
| Makefile | 2012-05-08 22:21:55 | 2.8 KiB | |
| manifest_preprocessor.txt | 2012-05-08 22:21:55 | 3.9 KiB | |
| mediated-links.txt | 2012-05-08 22:21:55 | 11.6 KiB | |
| multi-platform.rst | 2012-05-08 22:21:55 | 2.4 KiB | |
| multi-platform.txt | 2012-05-08 22:21:55 | 1.5 KiB | |
| on-disk-format.txt | 2012-05-08 22:21:55 | 44.2 KiB | |
| one-pager-main.txt | 2012-05-08 22:21:55 | 15.4 KiB | |
| parallel-linked-images.txt | 2012-07-30 23:45:41 | 9.9 KiB | |
| pkg-guide-web.css | 2012-05-08 22:21:55 | 881 | |
| pkg-states.rst | 2012-05-08 22:21:55 | 6.6 KiB | |
| pkg-states.txt | 2012-05-08 22:21:55 | 5.4 KiB | |
| pkgs-and-groups.txt | 2012-09-04 00:07:50 | 5.5 KiB | |
| protocol-versioning.txt | 2012-05-08 22:21:55 | 762 | |
| publication.txt | 2012-05-08 22:21:55 | 1.1 KiB | |
| publisher_search_order.txt | 2012-05-08 22:21:55 | 4.4 KiB | |
| razor.txt | 2012-05-08 22:21:55 | 3.7 KiB | |
| README.guide | 2012-05-08 22:21:55 | 1.8 KiB | |
| repository.txt | 2012-05-08 22:21:55 | 4.2 KiB | |
| rest.txt | 2012-05-08 22:21:55 | 909 | |
| rfes.txt | 2012-05-08 22:21:55 | 1.8 KiB | |
| sat.txt | 2012-05-08 22:21:55 | 7.9 KiB | |
| scripting.txt | 2016-02-26 14:05:21 | 6.2 KiB | |
| search.txt | 2016-02-26 14:05:21 | 3.7 KiB | |
| server_api_versions.txt | 2012-05-08 22:21:55 | 8.3 KiB | |
| signed_manifests.txt | 2012-05-08 22:21:55 | 11.3 KiB | |
| system_repository.txt | 2012-07-30 23:45:41 | 5.5 KiB | |
| tags-and-attributes.txt | 2012-05-08 22:21:55 | 10 KiB | |
| TODO | 2012-05-08 22:21:55 | 1.3 KiB | |
| transaction-order.txt | 2012-05-08 22:21:55 | 286 | |
| usr-setuid-bins.txt | 2012-05-08 22:21:55 | 1.6 KiB | |
| versions.txt | 2012-05-08 22:21:55 | 4.6 KiB | |
| wos-filetype-stats.txt | 2012-05-08 22:21:55 | 1.8 KiB | |
| xml.txt | 2012-05-08 22:21:55 | 866 |
README.guide
Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
0. Format
We're writing the Developer Guide in reStructured Text. Once we're
happy with the content, we'll output XML and convert that to
DocBook-XML to hand over to Documentation for final production.
Heading in rST are based on over- and underlining. Heading levels
are a document-specific convention; our levels are as follows:
==== ----
==== , ---- , ==== , ---- , ~~~~, ````, ^^^^
Inconsistencies with this ordering will lead to document build
failure.
1. Files
guide-main.rst is the Developer Guide's outline. It contains the
main document directives; it may also contain shorter sections,
prior to being broken out into separate files.
Each file should begin with its appropriate heading for the Guide as
a whole.
1.1. Titles
Titles are always mixed case. Particular levels may be set in
capitals or small capitals by style sheet.
2. Rest of the directory
Files not starting with guide- are legacy documents from earlier in
the project. If you are rewriting one of these to fit into the
Guide, please rename them; if you don't feel you're the owner,
extract the content, and add an "XXX Copied to guide-....rst" in the
original file.
3. Tools
You can obtain docutils by using easy_install via
$ pfexec easy_install docutils
With a straight docutils installation, you can build the "html"
target out of the Makefile.
To build the PDF version, you will need a pdflatex-capable TeX
installation, such as TeX Live, which is available for download at
The Makefile and docutils expect that the TeX executables are
available via the path.