diff options
author | Sol Jerome <sol.jerome@gmail.com> | 2011-07-27 13:53:28 -0500 |
---|---|---|
committer | Sol Jerome <sol.jerome@gmail.com> | 2011-07-27 13:53:28 -0500 |
commit | e7f6dd5dc96c8d4d8043c148c1a4c6e2b59fa99b (patch) | |
tree | 2c9fc6731aab51a1cbadb193eda20f4ddd45c60e | |
parent | 15157477233ec2f90d65ac2011757434a16cb5ba (diff) | |
download | bcfg2-e7f6dd5dc96c8d4d8043c148c1a4c6e2b59fa99b.tar.gz bcfg2-e7f6dd5dc96c8d4d8043c148c1a4c6e2b59fa99b.tar.bz2 bcfg2-e7f6dd5dc96c8d4d8043c148c1a4c6e2b59fa99b.zip |
doc: Provide examples of abstract and literal specifications
Signed-off-by: Sol Jerome <sol.jerome@gmail.com>
-rw-r--r-- | doc/architecture/server.txt | 13 | ||||
-rw-r--r-- | doc/server/configurationentries.txt | 2 |
2 files changed, 14 insertions, 1 deletions
diff --git a/doc/architecture/server.txt b/doc/architecture/server.txt index 1341f9e0a..d58b6629f 100644 --- a/doc/architecture/server.txt +++ b/doc/architecture/server.txt @@ -46,6 +46,12 @@ is tailored for the client. This process consists of the following steps: include a name. These configuration entries are grouped into bundles, which document installation time interdependencies. + Here is an example of an abstract configuration entry: + + .. code-block:: xml + + <Package name='openssh-server'/> + * **Configuration Binding** The abstract configuration determines the structure of the client @@ -63,3 +69,10 @@ is tailored for the client. This process consists of the following steps: specification. This specification is complete and comprehensive; the client doesn't need to process it at all in order to use it. It also represents the totality of the configuration specified for the client. + + Here is the entry from above once it has been bound to its literal + specification (In this case, using the Packages plugin). + + .. code-block:: xml + + <Package name="openssh-server" version="auto" type="deb"/> diff --git a/doc/server/configurationentries.txt b/doc/server/configurationentries.txt index 0c12ce9c9..35200da37 100644 --- a/doc/server/configurationentries.txt +++ b/doc/server/configurationentries.txt @@ -116,7 +116,7 @@ Path type specified. | | | checkout | | +-------------+----------------------+-----------------+--------------------------+ -Keep in mind that permissions for files served up by Cfg/TGenshi/TCheetah +Keep in mind that permissions for files handled by Cfg/TGenshi/TCheetah are still handled via the traditional :ref:`server-info` mechanisms. Additional information |