From 716c2d3ef36b602fc275844577853487afacc6d8 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Sat, 19 Jan 2013 09:51:14 -0600 Subject: doc: Fix formatting Signed-off-by: Sol Jerome --- doc/server/plugins/generators/cfg.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/server/plugins/generators/cfg.txt b/doc/server/plugins/generators/cfg.txt index e843b1d2d..f31923866 100644 --- a/doc/server/plugins/generators/cfg.txt +++ b/doc/server/plugins/generators/cfg.txt @@ -307,7 +307,7 @@ The Cheetah template is ignored. Exploiting this fact is probably a pretty bad idea in practice. You can mix Genshi and Cheetah when using different host-specific or -group-specific files. For example: +group-specific files. For example:: Cfg/etc/fstab/fstab.H_host.example.com.genshi Cfg/etc/fstab/fstab.G50_server.cheetah -- cgit v1.2.3-1-g7c22 From c8d93e151ede1b17ca2ad33b6480fd59166ec1a4 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Thu, 24 Jan 2013 13:10:28 -0500 Subject: docs: formatting fixes, updated reserved encryption options --- doc/server/encryption.txt | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/server/encryption.txt b/doc/server/encryption.txt index e84b9fb31..b56487620 100644 --- a/doc/server/encryption.txt +++ b/doc/server/encryption.txt @@ -164,9 +164,8 @@ For instance:: .. note:: - The name of a passphrase **cannot** be "algorithm"; that - configuration option is reserved for configuring the cipher - algorithm. + The name of a passphrase **cannot** be ``algorithm`` or + ``decrypt``, which are reserved for other configuration options. This would define two separate encryption passphrases, presumably for use by two separate teams. The passphrase names are completely @@ -212,7 +211,7 @@ though, that may not be possible. (For instance, if you use encryption to protect data for your production environment from your staging Bcfg2 server, then you would not expect the staging server to be able to decrypt everything.) In this case, you want to enable lax -decryption in the ``[encryption]`` section of ``bcfg2.conf``: +decryption in the ``[encryption]`` section of ``bcfg2.conf``:: [encryption] decrypt = lax -- cgit v1.2.3-1-g7c22 From d746166a7a984fc549f2c863020625f4c89ab5b3 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Fri, 1 Feb 2013 10:41:32 -0500 Subject: docs: document abstract Package tag --- doc/server/plugins/generators/packages.txt | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/server/plugins/generators/packages.txt b/doc/server/plugins/generators/packages.txt index e45864ef9..b6aa6190e 100644 --- a/doc/server/plugins/generators/packages.txt +++ b/doc/server/plugins/generators/packages.txt @@ -538,9 +538,10 @@ Package Groups -------------- Yum package groups are supported by the native Yum libraries. To -include a package group, use the :xml:attribute:`PackageType:group` -attribute of the :xml:element:`Package` tag. You can use either the -short group ID or the long group name: +include a package group, use the +:xml:attribute:`PackageStructure:group` attribute of the +:xml:element:`Package` tag. You can use either the short group ID or +the long group name: .. code-block:: xml @@ -563,13 +564,22 @@ Valid values of "type" are: * ``optional`` or ``all``: Install all packages in the group, including mandatory, default, and optional packages. -See :xml:element:`PackageStructure` for details. +See :xml:type:`PackageStructure` for details. You can view the packages in a group by category with the ``yum groupinfo`` command. More information about the different levels can be found at http://fedoraproject.org/wiki/How_to_use_and_edit_comps.xml_for_package_groups#Installation +Abstract Package Tags +--------------------- + +If you are using the native Yum libraries, the abstract Package tag +supports several attributes in addition to the standard +:xml:attribute:`PackageStructure:name`: + +.. xml:type:: PackageStructure + .. _pulp-source-support: Pulp Support -- cgit v1.2.3-1-g7c22 From 72815279878ee9368f8fd87a8c78010caadf1687 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Mon, 4 Feb 2013 10:39:29 -0500 Subject: changed to stock BSD 2-clause license --- doc/appendix/contributors.txt | 78 ------------------------------------------- doc/appendix/index.txt | 1 - 2 files changed, 79 deletions(-) delete mode 100644 doc/appendix/contributors.txt (limited to 'doc') diff --git a/doc/appendix/contributors.txt b/doc/appendix/contributors.txt deleted file mode 100644 index 1afc62706..000000000 --- a/doc/appendix/contributors.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. -*- mode: rst -*- - -.. _AUTHORS: http://trac.mcs.anl.gov/projects/bcfg2/browser/AUTHORS -.. _MCS: http://www.mcs.anl.gov/ - -.. _appendix-contributors: - -============ -Contributors -============ - -.. - This is list is no longer in chronological order like the - AUTHORS file because it's easier to maintain. - Automatically sorted. - -In alphabetical order of the given name: - -- Andrew Brestick fixed bugs and completed - plugins. -- Brian Pellin and Andrew Lusk did substantial work on Bcfg1, some of - which was used in the Bcfg2 client. -- Chris Vuletich wrote some SSL code and the - verification debugging code. -- Chris St. Pierre (re)wrote bcfg2-lint and has - made other miscellaneous contributions. -- Cory Lueninghoener wrote the showentries function - in ``bcfg2-info``. -- Daniel Clark created encap packages for bcfg2 and - deps, wrote fossil-scm dvcs support, and helps with Debian packaging. -- Danny Clark enabled the Encap packaging. -- David Dahl worked on Hostbase. -- David Strauss worked on CentOS, RHEL, Yum, and Bazaar VCS support. -- Ed Smith has done substantial hardening of the - Bcfg client and server and implemented a common logging infrastructure. -- Fabian Affolter made some patches, added - some new features and plugins, and restructured the manual for Bcfg2. -- Jack Neely worked on YUMng. -- James Yang worked on ``bcfg2-admin`` and - ``bcfg2-reports``. -- Jason Pepas has written a RPM package list creator - has contributed patches to the Red Hat toolset. -- Joey Hagedorn has written the reporting subsystem, - including StatReports, GenerateHostinfo, and the xslt, css and javascript - associated with it. -- Jos Catnook fixed bugs. -- Ken Raffenetti and Rick Bradshaw have written the - Hostbase plugin. -- Michael Jinks wrote the Gentoo tool drivers. -- Narayan Desai has written most of Bcfg2, including all - parts not explicitly mentioned in this file. -- Patrick Ruckstuhl fixed bugs in the templating. -- Pedro Flores made the Reporting system design help. -- Raul Cuza updated the documentation. -- Rick Bradshaw has written several of the tools - included in the ``tools/`` subdirectory. -- Robert Gogolok fixed bugs and made the code more - robust. -- Sami Haahtinen has written Debian packaging logic. -- Scott Behrens and Rick Bradshaw have written the - VHost plugin. -- Scott Matott -- Sol Jerome squashes bugs, helps manage the - project roadmap, and implements various interesting features. -- Ti Leggett worked on ebuild packaging and bugfixes, RPM packaging. -- Tim Laszlo worked on the reporting system and made - plugins. -- Zach Lowry Solaris support and general hardening. - - -The entire MCS_ systems team has provided invaluable help in the -design process and refinement of the user interface. In particular, -Gene Rackow and Sandra Bittner have provided great assistance -throughout this project. Philip Steinbachs provided detailed -feedback as an early external user. - -The most updated listing is available in the AUTHORS_ file in the -git :term:`repository` for Bcfg2. diff --git a/doc/appendix/index.txt b/doc/appendix/index.txt index 407119e24..135d00bc8 100644 --- a/doc/appendix/index.txt +++ b/doc/appendix/index.txt @@ -11,7 +11,6 @@ Appendix files configuration - contributors books papers articles -- cgit v1.2.3-1-g7c22 From e52a1299f5cc121d84d7fc3b4f01594fcae030c1 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Tue, 5 Feb 2013 08:59:49 -0500 Subject: documented xmlschema sphinx extension options/flags --- doc/exts/xmlschema.py | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) (limited to 'doc') diff --git a/doc/exts/xmlschema.py b/doc/exts/xmlschema.py index 8a68902e1..727b4bbd0 100644 --- a/doc/exts/xmlschema.py +++ b/doc/exts/xmlschema.py @@ -10,6 +10,30 @@ Provides the following directives: * ``.. xml:attributegroup:: ``: Document an attributeGroup * ``.. xml:element:: ``: Document an XML element +Each directive supports the following options: + +* ``:namespace: ``: Specify the namespace of the given entity +* ``:nochildren:``: Do not generate documentation for child entities +* ``:noattributegroups:``: Do not generate documentation about + attribute groups +* ``:nodoc:``: Do not include the documentation included in the entity + annotation +* ``:notext:``: Do not generate documentation about the text content + of the entity +* ``:onlyattrs: ,``: Only generate documentation about the + comma-separated list of attributes given +* ``:requiredattrs: ,attr>``: Claim that the attributes named in + the given comma-separated list are required, even if they are not + flagged as such in the schema. +* ``:linktotype: [,]``: If used as a flag, link to + documentation on all child types and elements. If a list is given, + only link to those types given. (The default is to generate full + inline docs for those types.) +* ``:noautodep: [,]``: Do not automatically generate docs + for any dependent entities. +* ``:inlinetypes: ,``: Override a default ``:linktotype:`` + setting for the given types. + Provides the following roles to link to the objects documented above: * ``:xml:schema:````: Link to an XML schema @@ -759,6 +783,8 @@ class XMLDomain(Domain): def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode): + if typ in ['complexType', 'simpleType']: + typ = 'type' if target in self.data[typ]: docname, labelid = self.data[typ][target] else: -- cgit v1.2.3-1-g7c22 From c4e632c2689b386dd547aa6169e9daf783af1afd Mon Sep 17 00:00:00 2001 From: Alexander Y Tiurin Date: Mon, 18 Feb 2013 09:29:35 -0600 Subject: doc: Fix typo (#1144) Signed-off-by: Sol Jerome --- doc/server/plugins/generators/rules.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/server/plugins/generators/rules.txt b/doc/server/plugins/generators/rules.txt index a3f29a803..2789411e7 100644 --- a/doc/server/plugins/generators/rules.txt +++ b/doc/server/plugins/generators/rules.txt @@ -393,7 +393,7 @@ For example: lp adm bin - + The group specified will automatically be created if it does not exist, even if there is no :xml:type:`POSIXGroup tag ` -- cgit v1.2.3-1-g7c22 From e17e41dcff096ead7e129a0db063f75de44aaa2b Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Wed, 20 Feb 2013 08:45:44 -0500 Subject: fixed unit tests using long ints for py3k --- doc/development/compat.txt | 2 ++ 1 file changed, 2 insertions(+) (limited to 'doc') diff --git a/doc/development/compat.txt b/doc/development/compat.txt index b7bf87bec..90df45676 100644 --- a/doc/development/compat.txt +++ b/doc/development/compat.txt @@ -98,6 +98,8 @@ behavior (e.g., :func:`input`) do not cause unexpected side-effects. +---------------------------------+--------------------------------------------------+---------------------------------------------------------+ | reduce | :func:`reduce` | :func:`functools.reduce` | +---------------------------------+--------------------------------------------------+---------------------------------------------------------+ +| long | :func:`long` | :func:`int` | ++---------------------------------+--------------------------------------------------+---------------------------------------------------------+ Python 2.4 compatibility ------------------------ -- cgit v1.2.3-1-g7c22