mirror of
https://codeberg.org/Toasterson/ips.git
synced 2026-04-10 21:30:41 +00:00
| .. | ||
| dev-guide | ||
| actions.rst | ||
| actions.txt | ||
| apt.txt | ||
| bhyve.md | ||
| boot_environments.txt | ||
| case-outline.txt | ||
| catalog-v1.txt | ||
| catalog.txt | ||
| client_api_versions.txt | ||
| deduction.txt | ||
| depot.rst | ||
| depot.txt | ||
| directory_perms.txt | ||
| elf-jar-handling.txt | ||
| es-requirements.txt | ||
| facets.txt | ||
| file-metadata.txt | ||
| filter.txt | ||
| guide-basic-ops.rst | ||
| guide-implementation-depot.rst | ||
| guide-main.rst | ||
| guide-metadata-conventions.rst | ||
| guide-naming-conventions.rst | ||
| guide-pkg-states.rst | ||
| guide-publication-protocol.rst | ||
| guide-repository-format.rst | ||
| guide-retrieval-protocol.rst | ||
| guide-txn-states.rst | ||
| history.txt | ||
| image.rst | ||
| image.txt | ||
| kvm.md | ||
| license.txt | ||
| linked-images.txt | ||
| macros.rst | ||
| Makefile | ||
| manifest_preprocessor.txt | ||
| mediated-links.txt | ||
| multi-platform.rst | ||
| multi-platform.txt | ||
| on-disk-format.txt | ||
| one-pager-main.txt | ||
| parallel-linked-images.txt | ||
| pkg-guide-web.css | ||
| pkg-states.rst | ||
| pkg-states.txt | ||
| pkgs-and-groups.txt | ||
| protocol-versioning.txt | ||
| publication.txt | ||
| publisher_search_order.txt | ||
| razor.txt | ||
| README.guide | ||
| repository.txt | ||
| rest.txt | ||
| rfes.txt | ||
| sat.txt | ||
| scripting.txt | ||
| search.txt | ||
| server_api_versions.txt | ||
| signed_manifests.txt | ||
| system_repository.txt | ||
| tags-and-attributes.txt | ||
| TODO | ||
| transaction-order.txt | ||
| usr-setuid-bins.txt | ||
| versions.txt | ||
| wos-filetype-stats.txt | ||
| xml.txt | ||
Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
README.guide
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
http://www.tug.org/texlive/
The Makefile and docutils expect that the TeX executables are
available via the path.