Developer Operations Plugin Manual

Next: , Previous: , Up: (dir)   [Index]

Developer Operations Plugin Manual

This manual documents MIT/GNU Scheme Pucked Developer Operations 0.14.

Copyright © 2016, 2017, 2018, 2019 Matthew Birkholz

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License.”


Next: , Up: Top   [Index]

1 Introduction

MIT/GNU Scheme Pucked Developer Operations (devops) is a system of code for managing The Source of MIT/GNU Scheme Pucked and its plugins. A large part of this is a build system that does lint-like checks for consistency between core and plugin source code and documentation. This devops plugin is also a developer’s manual describing the build system and addressing implementation issues like just how is MIT/GNU Scheme Pucked.


Next: , Previous: , Up: Top   [Index]

2 How so “pucked?”

The user visible differences between MIT/GNU Scheme version 10.1.10 and MIT/GNU Scheme Pucked version 10.1.20 are detailed in Release Notes in MIT/GNU Scheme Pucked User Manual. This chapter is a review of all source code changes, with reference to the output of specific git diff commands.

The commands in this chapter assume you have cloned the project git repository, fetched the experimental branch, and checked it out, as described in Project Repository.

The following commands can be (have been!) used in a clone like the one described above. They show all differences between the master branch on Savannah (origin/master) and the experimental branch in the repository at Birchwood Abbey, puck/pucked. The discussion following each command is a quick summary of the diffs.

cmd="git diff origin/master puck/pucked --"

The command lines in this table assume you have defined cmd as above.

$cmd dist/

PROJECT_NAME was changed. debian/ is included in the source distribution, and all plugin code is removed.

$cmd doc/

The project name, email and version were changed. The manpage and user’s manual were renamed and updated. All manuals were changed to fit inside a new, top-level mit-scheme-pucked.info file, the only Info file installed in the system Directory node. HTML versions of the manuals are installed in htmldir with an index and style sheet. Plugin manuals are also installed there and added to the index.

$cmd etc/

No changes were made.

$cmd src/microcode/

The project and program names were changed as well as the microcode version and copyright notice. Barak Pearlmutter’s patch “allow autoreconf force” was applied to avoid a hitch in the Debian package build. Support for multiple executables (for multiple Scheme architectures) was dropped.

$cmd src/runtime/

The pucked feature was introduced. The runtime source is now included (installed) so runtime options need not be installed specially.

$cmd src/edwin/

Edwin was changed to accommodate a new Gtk Screen plugin. The old screen structure type became the abstract SOS class <screen> and the concrete class <tty-screen>. Most of the existing, tty-specific screen procedures were renamed with a tty- prefix. Many are called only by other tty procedures. The few (20) that handle any type of screen became SOS generic procedures.

$cmd src/etc/

The Emacs tutorial was moved to the Edwin plugin’s source directory. Pucked options are not pre-installed so they were removed from the default optiondb.scm.

$cmd src/imail/

The IMAIL manual was renamed and edited for installation in a new, top-level mit-scheme-pucked.info file in the ${scmdocdir}/info/ directory. A few minor changes were needed to make this plugin buildable separately from the core.

$cmd src/compiler/ src/cref/ src/sf/ src/star-parser/

No changes were made to the rest of the core subsystems except their Makefile-fragments. These now install all source files.

$cmd src/ffi/

The procedures for updating indices of plugins and their documentation needed some adjustment to avoid creating a second list of plugins in scmdocdir. And like the other subsystems above, Makefile-fragment was simplified; it now installs all source files.

$cmd src/6001/ src/sos/ src/ssp/ src/win32/ src/xdoc/ src/xml/

No changes were made to the rest of the standard subsystems except their Makefile-fragments.

$cmd tests/

No changes were made to the test suites.


Next: , Previous: , Up: Top   [Index]

3 Build System

The goal of the devops build system is to release from a developer’s git repository lint free source distributions with binaries for several different machine architectures and operating systems. The binaries for each combination of architecture and operating system are built by a separate “build host.” Ubuntu hosts build Debian packages as well as the traditional binaries. Both packages and binaries are installed as they are built, to test their installation and to satisfy the build dependencies of subsequent releases.

The release process begins in the developer’s git repository, in a git clean, lint free, well tested working directory. A release is created by creating a git tag, building source distributions from that tag, and pushing/uploading the tag/distributions to the shared project repository (if not the same as the developer’s repository).

The build process begins in the project git repository, possibly a bare repository on a shared server, where a build status report polls each build host using passwordless ssh. The status report automatically uploads new releases (if any) and launches a build (if necessary), or reports the error that has stopped the build on that host. Releases are built serially, in the order that they were created. No dependency checking is currently in place.


Next: , Up: Build System   [Index]

3.1 Project Repository

The devops build system assumes it runs in the working directory of a git repository, e.g. a clone of a project repository. The current branch can contain one or more plugins and/or a core Scheme.

For example the MIT/GNU Scheme project repository might be cloned and the pucked branch (with experimental plugins) fetched from Birchwood Abbey. Fixes would be commited on a local branch, perhaps called unpucked, that tracks pucked. The following commands could be used to check out pucked, then start an unpucked tracking branch.

git clone git://git.savannah.gnu.org/mit-scheme.git
cd mit-scheme/
git remote add puck git://birchwood-abbey.net/~puck/mit-scheme.git
git fetch puck pucked
git checkout puck/pucked
# Fix, then decide to commit on a local branch named "unpucked".
git checkout -b unpucked --track puck/pucked
git add .
git commit
# Later.
git pull puck pucked

Next: , Previous: , Up: Build System   [Index]

3.2 Project Configuration

The devops build system is configured by a config.scm file in its build area, devops/ (possibly a symbolic link). The devops/config.scm file is loaded into the (devops) package where it can find procedures to set build system variables.

Procedure: project-name [name]

Returns the project name (a string) after setting it to name (when provided). Name should be a lower case string without whitespace or punctuation; it is used to create file names. Until it is set the project name is "new-scheme".

Procedure: plugin name directory

Adds a plugin to the project. Name should be a string. It will be concatenated with the project name and a hyphen to create package file names. Directory should be a string naming a subdirectory of the repository, the root of the plugin source tree.

Procedure: host name user directory arch os

This procedure adds a build host to the project. New sources will be uploaded to user@name:directory/ using passwordless scp. Arch should be the Scheme architecture (e.g. "i386" or "svm1-64"). Os is a string naming the host’s operating system. If it starts with "Ubuntu" and mentions a recent Ubuntu version, the host will build Debian packages.

Procedure: main

This procedure is for the convenience of scripts. It dispatches off the first argument on Scheme’s command line to execute one of the build procedures (e.g. devops:status). For example:

  #!/bin/bash

  exec mit-scheme-pucked --batch-mode -- "$@" <<\EOF
  (begin
    (parameterize ((param:suppress-loading-message? #t))
      (load-option 'devops))
    ((access main (->environment '(devops)))))
  EOF

Next: , Previous: , Up: Build System   [Index]

3.3 Debugging Builds

A debugging build runs in the working directory of a developer’s git repository (or shadow thereof) and provides special options to core and plugin ./configure scripts (e.g. "--enable-debugging"). The build begins by loading a devops-config.scm file into the (devops) package where it can adjust many aspects of the build. The special options for the build are specified by applying make-configuration to a list of strings.

Procedure: make-configuration . options

Options should be a list of strings to be passed as arguments to the ./configure scripts of the core and plugins. They are not shell escaped. A space is inserted between them.

An example devops-config.scm file:

;; Shared configuration.
(load (merge-pathnames "devops/config.scm"
                       (current-load-pathname)))
;; Build-specific configuration.
(make-configuration "--enable-debugging")

If the working directory contains src, doc and tests subdirectories it is assumed to contain a core system. In this case a --prefix option is added to the core build configuration so that the core is installed in the subdirectories bin, lib and share. The test core is built and installed first, and is used as the host Scheme for plugin builds and installs. There is no inter-plugin dependency analysis currently, so plugins are built and installed serially in the order they were created.

To accommodate multiple debugging builds, a “shadow” of the working directory can be created. A shadow directory contains symbolic links to the files in a source directory and shadows of its subdirectories, much like the shadow directories created by the X11 build utility lndir. If the build starts in a subdirectory of the working directory, it will assume the build is intended to run in shadows of the working directories. If it does not find a devops-config.scm file in this subdirectory, it will attempt to load one from the working directory.

Procedure: devops:make target

Target is optional and defaults to native which specifies a core with the same Scheme architecture as the host. It can also be the symbol svm which specifies a core cross-compiled to a Scheme virtual machine with the same word size as the host. Plugins, unlike the core, are always native to their host Scheme compiler ${MIT_SCHEME_EXE=mit-scheme} (as well as their C compiler ${CC=gcc}, dynamic linker, etc.).

This procedure is continuable. When restarted it first checks any shadow directories for missing or incorrect links, then re-makes and re-installs the core (if any) and each plugin in order. Note that this does not take into account syntactic dependencies between plugins. If a plugin exports syntax and changes how that syntax expands, any plugins using the syntax will need to be cleaned (at least partially) and re-built.


Next: , Previous: , Up: Build System   [Index]

3.4 Release Process

The release process runs in a git repository on a developer’s machine. Presumably the working directory is clean, tested and free of lint. It represents the head of a short chain of commits going back to the previous release tag. That chain should be reviewed for changes or enhancements that deserve mention in the NEWS file or documentation.

Often a chain of commits represents an enhancement that is immediately put to use in new code. The core might offer a new service and several plugins take advantage of it. The release process should tag a new core version first, update the plugins with the new core version dependency, then tag the new versions of the plugins.

To begin the process a developer needs to know whether the working directory tree is git clean (with all changes committed) and lint free. Presumably this was the state when the candidate release was tested. The developer also needs to know if the core has been changed since its last release, which plugins have changed, and what files changed.

Procedure: devops:status [plugin]

Write a status report listing the commits to be released and warning of unclean files, lint, or other possible trouble. The current working directory should be the top of the git repository. If plugin is not provided the statuses of all plugins (and core) are reported, else plugin should be a symbol or string—the name of a plugin.

With the status report well considered, the developer will create a release tag and build its source distribution. If a shared server is in use, the tag is pushed and the source is uploaded.

Procedure: devops:release [plugin]

Warn of unclean files, lint, or other possible trouble, but tag plugin (or core) regardless and build a source distribution. If plugin is not provided the core is released. If name is “snapshot” source distributions are created for all changed plugins (or core) but no git tags.

Procedure: tag-options . options

Options should be a list of strings to be passed as arguments in the git tag shell command line used to tag a release. They are not shell escaped. A space is inserted between them.


Next: , Previous: , Up: Build System   [Index]

3.5 Build Process

The build process begins in the project (or developer) git repository, possibly a bare repository on a shared server, where a new release tag and source distribution have recently appeared. Running the build status report here causes each build host to be contacted by passwordless ssh. New source distributions are uploaded and build daemons spawned. Subsequent status reports show what the daemons are working on and what remains to be done.

Rather than track dependencies between releases and order builds accordingly, the build daemons just work through them sequentially in the order they were released (by file modification dates). If a build fails no further builds are attempted until the error log is removed. Another build status report will spawn a daemon to continue the work.

Procedure: devops:build

Polls each build host. Uploads new releases. Shows what the build daemon is working on and the work that remains to be done.

Each build host needs a host Scheme installed, typically the latest release of MIT/GNU Scheme. It will also need any C headers and libraries required to build the desired plugins. The core binary packages are installed in /usr/local/ and the Ubuntu packages in /usr/. Each plugin is built by and installed in the core Scheme(s). For passwordless installation the /usr/local/ directory tree should be writable by the builder.

On an Ubuntu host the builder must be able to install new packages using passwordless sudo. This might be arranged with an entry in /etc/sudoers, e.g.

puck ALL=(root) NOPASSWD: /usr/local/sbin/mit-scheme-pucked-install

and a short script, e.g.

#!/bin/bash
set -e
exec dpkg --install "/home/puck/mit-scheme/$1"

Previous: , Up: Build System   [Index]

3.6 Lint Detection

All of the devops release procedures warn of “lint” in the source code and documentation. At the moment, only out-of-date version numbers are detected. Eventually a few more standard constraints might be checked, but lint detection is a matter of rather idiosyncratic project policy. Most lint detection is expected to happen in the lint hooks.

Procedure: core-lint-hook version changes dirt

If true, the value of this binding is applied to three arguments.

  1. version—A string like "10.1.7".
  2. changes—A list of strings, the paths (relative to the root of the git working directory tree) to files that have changed since the last release.
  3. dirt—A list of strings, the paths (relative) to the “dirty” files, files with uncommitted changes.

The value of the hook should be a list of strings, messages for the luser.

Procedure: plugin-lint-hook plugin version changes dirt

Like core-lint-hook but takes an additional argument: plugin—an object created by the plugin procedure.

A few procedures are made available in the (devops) package to aid in the definition of procedures that check for project policy violations.

A couple procedures can be applied to the plugin objects passed as arguments to the plugin-lint-hook. They access the name and directory provided to the plugin procedure when the object was created. See plugin.

Procedure: plugin-name plugin

Returns the string naming the plugin object.

Procedure: plugin-directory plugin

Returns the string naming the subdirectory of the git repository, the root of plugin’s source tree.

There is just one procedure for checking policy.

Procedure: plugin-deffn-lint plugin pkg exceptions

If plugin’s source contains a .texi file with the same name, check that it has a Texinfo @deffn for each binding exported to the global package and the pkg package (if pkg is not false). Exceptions should be a list of names (symbols) to ignore.


Next: , Up: Lint Detection   [Index]

3.6.1 Core Lint

The following checks are performed on a core Scheme source tree.


Previous: , Up: Lint Detection   [Index]

3.6.2 Plugin Lint

The following checks are performed on a plugin source tree.


Next: , Previous: , Up: Top   [Index]

Appendix A GNU Free Documentation License

Version 1.2, November 2002
Copyright © 2000,2001,2002 Free Software Foundation, Inc.
51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA

Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
  1. PREAMBLE

    The purpose of this License is to make a manual, textbook, or other functional and useful document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

    This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

    We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.

  2. APPLICABILITY AND DEFINITIONS

    This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.

    A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

    A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

    The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.

    The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.

    A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.

    Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.

    The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.

    A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.

    The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.

  3. VERBATIM COPYING

    You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

    You may also lend copies, under the same conditions stated above, and you may publicly display copies.

  4. COPYING IN QUANTITY

    If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

    If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

    If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

    It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.

  5. MODIFICATIONS

    You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

    1. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
    2. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
    3. State on the Title page the name of the publisher of the Modified Version, as the publisher.
    4. Preserve all the copyright notices of the Document.
    5. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
    6. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
    7. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document’s license notice.
    8. Include an unaltered copy of this License.
    9. Preserve the section Entitled “History”, Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled “History” in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
    10. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the “History” section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
    11. For any section Entitled “Acknowledgements” or “Dedications”, Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
    12. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
    13. Delete any section Entitled “Endorsements”. Such a section may not be included in the Modified Version.
    14. Do not retitle any existing section to be Entitled “Endorsements” or to conflict in title with any Invariant Section.
    15. Preserve any Warranty Disclaimers.

    If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.

    You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

    You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

    The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.

  6. COMBINING DOCUMENTS

    You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

    The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

    In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements.”

  7. COLLECTIONS OF DOCUMENTS

    You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

    You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.

  8. AGGREGATION WITH INDEPENDENT WORKS

    A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.

    If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.

  9. TRANSLATION

    Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warrany Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.

    If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.

  10. TERMINATION

    You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

  11. FUTURE REVISIONS OF THIS LICENSE

    The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.

    Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.

A.1 ADDENDUM: How to use this License for your documents

To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:

  Copyright (C)  year  your name.
  Permission is granted to copy, distribute and/or modify this document
  under the terms of the GNU Free Documentation License, Version 1.2
  or any later version published by the Free Software Foundation;
  with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
  A copy of the license is included in the section entitled ``GNU
  Free Documentation License''.

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with...Texts.” line with this:

    with the Invariant Sections being list their titles, with
    the Front-Cover Texts being list, and with the Back-Cover Texts
    being list.

If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.


Previous: , Up: Top   [Index]

Appendix B Binding Index

Jump to:   C   D   H   M   P   T  
Index Entry  Section

C
core-lint-hook: Lint Detection

D
devops:build: Build Process
devops:make: Debugging Builds
devops:release: Release Process
devops:status: Release Process

H
host: Project Configuration

M
main: Project Configuration
make-configuration: Debugging Builds

P
plugin: Project Configuration
plugin-deffn-lint: Lint Detection
plugin-directory: Lint Detection
plugin-lint-hook: Lint Detection
plugin-name: Lint Detection
project-name: Project Configuration

T
tag-options: Release Process

Jump to:   C   D   H   M   P   T