Anexos

Bibliografía

Software Configuration Management, Bersoff, Henderson & Siegel, Prentice-Hall, 1980

[IEEE828-98] IEEE Std 828-1998, IEEE Standard for Software Configuration Management Plans, IEEE, 1998.

Eduardo Romero Moreno, Migración Escritorio Software Libre, 2011

Glosario de términos

Auditoría. Análisis cuyo objetivo es revisar y evaluar la gestión efectuada.

Alerta. Aviso para que el usuario preste su atención a una determinada situación.

Atributo. Valor concreto que toma una propiedad al ser ejecutada en un equipo.

Cambio. Actividad que modifica un ECS, generando una nueva versión del ECS.

CID. Computer Identificator. Número que identifica inequívocamente a una placa base y por tanto a un ordenador.

ECS. Elemento de configuración software. Objeto software sometido a la GCS.

Falla. Hecho negativo que se produce en un equipo cliente

GCS. Gestión de la configuración software. Proceso de la Ingeniería del Software que identifica, hace seguimiento y controla cada uno de los cambios que se producen en los sistemas.

Liberación. Actividad de situar una versión del ECS en un repositorio para que los clientes del ECS puedan acceder a él e instalarlo.

Metadatos. Información sobre los datos.

Paquete. Contenedor que encapsula un conjunto de ECS liberados junto a sus metadatos.

Paquete huérfano. Paquete que no está en ningún repositorio.

PMS. Package Management System - Gestor de paquetes. Programa que permite aplicar en un equipo, los cambios que han sido liberados en los repositorios.

Propiedad. Código que devolverá una determinada característica de los equipos o de los usuarios.

Repositorio. Almacén de ECS.

Repositorio migasfree. Añade a un repositorio la capacidad de establecer cuándo y quién tiene acceso al repositorio.

Systems Management System. Gestor de sistemas. Software que permite la administración de escritorios de manera centralizada.

API

La belleza es el acuerdo entre el contenido y la forma.

—Henrik Johan Ibsen

El objetivo de este capítulo es describir la API de migasfree.

Desde sus inicios migasfree ha contado con una API propia pero desde la versión 4.11 del servidor se está incorporado una nueva API REST al servidor migasfree con objeto de substituirla totalmente.

Puedes consultar la autodocumentación de la API REST de migasfree accediendo a http://<miservidor>/docs o haciendo click en el icono del espía que aparece situado abajo a la derecha en todas las páginas de la aplicación web del servidor.

El proyecto fun-with-migasfree-examples incluye un directorio llamado api-examples donde encontraŕas código de ejemplo para hacer uso de la API REST.

Si aún no te has bajado los ejemplos ahora puede ser un buen momento para hacerlo y echarle un ojo al uso de la API REST.

$ wget https://github.com/migasfree/fun-with-migasfree-examples/archive/4.13.zip
$ unzip 4.13.zip
$ cd fun-with-migasfree-examples-4.13/api-examples

En cuanto a la API antigua (y que va a desaparecer en el futuro) podemos decir que tiene 2 tipos de API:

  • Pública:

    • Son accesibles públicamente.
    • Utilizan el metodo GET de HTTP para el envío de parámetros
  • Privada:

    • Comparten entre sí la misma manera de llamar a las funciones.

    • Envían un fichero en el parámetro message del método POST HTTP, cuyo nombre de fichero debe usar el siguiente formato:

      <COMPUTER_NAME>.<UUID>.<API_FUNCTION>
      
    • En el contenido del fichero message se introduce, en formato json lo que denominamos el API Private Data con los parámetros de entrada de las funciones.

    • En la mayoría de los casos este API Private Data es firmado usando la KEY de la Version ó del Empaquetador añadiendo esta firma al final del fichero:

      ``API Private Data`` + sign(``API Private Data``)
      
    • En el menor de los casos estas funciones en vez de firma requieren el uso de un usuario y contraseña que simplemente se introduce en el propio API Private Data.

    • Los valores devueltos por la funciones se reciben en formato json convenientemente firmados por el servidor, siguiendo la estructura:

      {"<API_FUNCTION>.return": ``API Private Data`` } +
          sign({"<API_FUNCTION>.return": ``API Private Data`` })
      

get_versions

Pertenece a la API pública.

Devuelve una lista de diccionarios de las plataformas con sus versiones correspondientes.

Parámetros de entrada

  • Ninguno

Salida

  • Lista de diccionarios de plataformas:

    • plafform: Nombre de la plataforma.

    • versions: Lista de diccionarios de versiones:

      • name: Nombre de la version.

Veamos un ejemplo. Si en un navegador web accedemos a la siguiente dirección:

http://miservidor/get_versions

Obtendremos una cadena de texto en formato json parecida a esta:

[{"platform": "Linux", "versions": [{"name": "ACME-1"}, {"name": "debian-7.0"}]}]

get_computer_info

Pertenece a la API pública.

Obtiene un diccionario con información relevante del ordenador consultado.

Parámetros de entrada

  • uuid: Como parámetro de método GET en la petición HTTP debe indicarse el identificador único de la placa base del ordenador.

Salida

  • Diccionario de datos del equipo:

    • search: Valor del primer campo indicado en la lista MIGASFREE_COMPUTER_SEARCH_FIELDS de los Ajustes del servidor migasfree y que sirve para facilitar la identificación del equipo en vez de usar el uuid.

    • name: Nombre del ordenador.

    • tags: Lista de cadenas de texto con los nombres de las Etiquetas asignadas al ordenador.

    • available_tags: Diccionario de Propiedades de tipo Etiqueta.

      • <Propiedad>: Lista de cadenas de texto con el nombre de las etiquetas.
    • helpdesk: Cadena de texto MIGASFREE_HELP_DESK de los Ajustes del servidor migasfree

    • id: Número identificador del ordenador en la tabla de Ordenadores

    • uuid: Identificador único de la placa base del ordenador

Veamos un ejemplo accediendo a:

http://miservidor/get_computer_info/?uuid=E9E66900-CBD4-9A47-B2EC-6ED0367A3AFB

obtendríamos algo parecido a esto:

{"search": 2, "name": "debian-client", "tags": [], "available_tags": {},
"helpdesk": "Put here how you want to be found", "id": 2,
"uuid": "E9E66900-CBD4-9A47-B2EC-6ED0367A3AFB"}

computer_label

Pertenece a la API pública.

Obtiene una página html que muestra la etiqueta que debe pegarse físicamente en el equipo para facilitar su identificación aún estando éste apagado.

Es utilizada por el comando migasfree-label.

Parámetros de entrada

  • uuid: Como parámetro de método GET en la petición HTTP debe indicarse el identificador único de la placa base del ordenador.

Salida

  • La página html de la etiqueta:

Por ejemplo al ejecutar:

http://miservidor/computer_label/?uuid=E9E66900-CBD4-9A47-B2EC-6ED0367A3AFB

Podemos obtener algo como:

Comando migasfree-label

figura 18.1. Comando migasfree-label.

register_computer

Pertenece a la API Privada.

Necesita usuario y contraseña con permisos de lectura/escritura en Ordenadores, y en Plataformas y Versiones si MIGASFREE_AUTOREGISTER está activo. Ver Ajustes del servidor migasfree

Esta función realiza lo siguiente:

  • Registra el Ordenador en el servidor.
  • Añade la Plataforma y/o Version del ordenador si no existen, siempre y cuando MIGASFREE_AUTOREGISTER esté activo.
  • Añade las correspondientes Notificaciones
  • Como resultado se obtendrán las KEYS de la Version que usarán las funciones de la API pública que las requieren.

API Private Data Input

  • username: Nombre del usuario
  • pasword: Contraseña
  • platform: Plataforma del ordenador.
  • version: Version del ordenador.
  • pms: Sistema de paqeuetería.
  • ip: Dirección ip.

API Private Data Output

  • migasfree-server.pub: KEY pública del servidor,

  • migasfree-client.pri: KEY privada de la versión.

  • errmfs: Diccionario con el posible error devuelto.

    • code: Código del error. Un valor de cero indica que no ha habido error.
    • info: Texto desciptivo del error.

get_key_packager

Pertenece a la API Privada.

Necesita usuario y contraseña con permisos de lectura/escritura en Paquetes.

Obtiene la KEY que permitirá subir paquetes al servidor con el comando de cliente migasfree-upload.

API Private Data Input

  • username: Nombre del usuario.
  • password: Contraseña del usuario.

API Private Data Output

  • migasfree-server.pub: KEY pública del servidor,

  • migasfree-packager.pri: KEY privada del Empaquetador.

  • errmfs: Diccionario con el posible error devuelto.

    • code: Código del error. Un valor de cero indica que no ha habido error.
    • info: Texto desciptivo del error.

upload_server_package

Pertenece a la API Privada.

Necesita firmar con KEY de Empaquetador.

Sube un paquete al servidor.

El fichero del paquete debe enviarse en HttpRequest.FILES["package"]

API Private Data Input

  • version: Versión.
  • store: Ubicación donde se almacena el paquete.
  • source: Valor booleano que indica si el paquete es el binario ó el fuente .

API Private Data Output

  • errmfs: Diccionario con el posible error devuelto.

    • code: Código del error. Un valor de cero indica que no ha habido error.
    • info: Texto desciptivo del error.

upload_server_set

Pertenece a la API Privada.

Necesita firmar con KEY de Empaquetador.

Sube un paquete de un Conjunto de Paquetes al servidor .

El fichero del paquete debe enviarse en HttpRequest.FILES["package"]

API Private Data Input

  • version: Versión.
  • store: Ubicación donde se almacena el paquete.
  • packageset: Conjunto de Paquetes en el que está incluido el paquete.

API Private Data Output

  • errmfs: Diccionario con el posible error devuelto.

    • code: Código del error. Un valor de cero indica que no ha habido error.
    • info: Texto desciptivo del error.

create_repositories_of_packageset

Pertenece a la API Privada.

Necesita firmar con KEY de Empaquetador.

Se utiliza para forzar la creación de los metadatos de los Repositorios en donde está asignado el Conjunto de Paquetes especificado.

Se usa despues de subir todos los paquetes de un Conjunto de Paquetes.

API Private Data Input

  • packageset: El nombre del Conjunto de Paquetes.
  • version: La Version del Conjunto de Paquetes.

API Private Data Output

  • errmfs: Diccionario con el posible error devuelto.

    • code: Código del error. Un valor de cero indica que no ha habido error.
    • info: Texto desciptivo del error.

upload_computer_message

Pertenece a la API Privada.

Necesita firmar con KEY de Version.

Envia un mensaje de texto al servidor informando que proceso esta realizando el cliente. Es utilizado por migasfree --update

API Private Data Input

El mensaje de texto que se quiere enviar al servidor.

API Private Data Output

  • errmfs: Diccionario con el posible error devuelto.

    • code: Código del error. Un valor de cero indica que no ha habido error.
    • info: Texto desciptivo del error.

get_properties

Pertenece a la API Privada.

Necesita firmar con KEY de Version.

Obtiene las Propiedades activas en el servidor migasfree.

API Private Data Input

No requiere.

API Private Data Output

  • properties: Lista de diccionarios con las Propiedades:

    • prefix: Prefijo de la propiedad
    • function Instrucciones de la Propiedad
    • language Lenguaje en que está programado la propiedad.
  • errmfs: Diccionario con el posible error devuelto.

    • code: Código del error. Un valor de cero indica que no ha habido error.
    • info: Texto desciptivo del error.

upload_computer_info

Pertenece a la API Privada.

Necesita firmar con KEY de Version.

Dados los datos del ordenador Obtiene del servidor diferente información con lo que el cliente debe hacer para realizar una actuliazación.

API Private Data Input

  • computer: Diccionario con información relativa al Ordenador

    • hostname: Nombre del ordenador.
    • ip: Dirección ip del ordenador.
    • platform: Plataforma.
    • version: Nombre de la Version.
    • user: Cuenta del usuario que esta logueado en la sesión gráfica.
    • user_fullname: Nombre completo del usuario
  • attributes: Lista de diccionarios con los Atributos conseguidos al ejecutar cada una de las Propiedades

    • <ATTRIBUTES_NAME>: Valor del Atributo

API Private Data Output

  • faultsdef: Lista de diccionarios de Definiciones de Fallas

    • name: Nombre de la falla.
    • function: Instrucciones de la falla.
    • language: Lenguaje en que está escrita la falla.
  • repositories: Lista de diccionarios de repositorios que deben configurarse en el cliente y que han sido seleccionados por el servidor en función de los atributos de entrada y la fecha actual.

    • name:
  • packages: Diccionario de paquetes.

    • install: Lista de cadenas de texto con los paquetes a instalar.
    • remove: Lista de cadenas de texto con los paquetes a desinstalar.
    • base: True si es el ordenador de referencia.
    • hardware_capture: True si el ordenador tiene que enviar el hardware.
    • devices: #TODO
  • errmfs: Diccionario con el posible error devuelto.

    • code: Código del error. Un valor de cero indica que no ha habido error.
    • info: Texto desciptivo del error.

upload_computer_faults

Pertenece a la API Privada.

Necesita firmar con KEY de Version.

Sube el resultado de las Fallas.

API Private Data Input

Diccionario con las Fallas:

  • <PROPIEDAD>: Texto de la salida estándar al ejecutar la FALLA

API Private Data Output

  • errmfs: Diccionario con el posible error devuelto.

    • code: Código del error. Un valor de cero indica que no ha habido error.
    • info: Texto desciptivo del error.

upload_computer_hardware

Pertenece a la API Privada.

Necesita firmar con KEY de Version.

Sube el hardware del Ordenador.

API Private Data Input

Salida en formato json del comando lshw.

API Private Data Output

  • errmfs: Diccionario con el posible error devuelto.

    • code: Código del error. Un valor de cero indica que no ha habido error.
    • info: Texto desciptivo del error.

upload_computer_software_base_diff

Pertenece a la API Privada.

Necesita firmar con KEY de Version.

Sube la diferencia respecto al ordenador base

API Private Data Input

Texto con la lista de paquetes respecto al ordenador base separados por retornos de carro.

API Private Data Output

  • errmfs: Diccionario con el posible error devuelto.

    • code: Código del error. Un valor de cero indica que no ha habido error.
    • info: Texto desciptivo del error.

upload_computer_software_base

Pertenece a la API Privada.

Necesita firmar con KEY de Version.

Lo utiliza el Ordenador de referencia para informar de los paquetes que tiene instalados

API Private Data Input

Texto con la lista de paquetes instalados separados por retornos de carro.

API Private Data Output

  • errmfs: Diccionario con el posible error devuelto.

    • code: Código del error. Un valor de cero indica que no ha habido error.
    • info: Texto desciptivo del error.

upload_computer_software_history

Pertenece a la API Privada.

Necesita firmar con KEY de Version.

Informa de cambio en el software.

API Private Data Input

Texto con el cambio de paquetes producidos en el Ordenador. Sigue el formato:

# [<FECHA DESDE>, <FECHA_HASTA]
<ACTION><PACKAGE> ,
<ACTION><PACKAGE> , ...

dónde ACTION puede ser (-) para indicar desintalado y (+) para indicar paquete instalado.

API Private Data Output

  • errmfs: Diccionario con el posible error devuelto.

    • code: Código del error. Un valor de cero indica que no ha habido error.
    • info: Texto desciptivo del error.

get_computer_software

Pertenece a la API Privada.

Necesita firmar con KEY de Version.

Obtiene el conjunto de paquetes del Ordenador de referencia.

API Private Data Input

No requiere.

API Private Data Output

  • Texto con la lista de paquetes del Ordenador de referencia separados por retorno de carro

  • errmfs: Diccionario con el posible error devuelto.

    • code: Código del error. Un valor de cero indica que no ha habido error.
    • info: Texto desciptivo del error.

upload_computer_errors

Pertenece a la API Privada.

Necesita firmar con KEY de Version.

Sube los errores producidos en el cliente.

API Private Data Input

Texto con el errores que han producido en el cliente.

API Private Data Output

  • errmfs: Diccionario con el posible error devuelto.

    • code: Código del error. Un valor de cero indica que no ha habido error.
    • info: Texto desciptivo del error.

get_computer_tags

Pertenece a la API Privada.

Necesita firmar con KEY de Version.

Obtiene las etiquetas del Ordenador y las disponibles en el sistema.

API Private Data Input

No requerido

API Private Data Output

  • selected: Lista de textos con las Etiquetas asignadas al ordenador.

  • available: Diccionario de Propiedades

    • <PROPERTY>: Lista de textos con las Etiquetas disponibles por cada Propiedad` de tipo ``tag
  • errmfs: Diccionario con el posible error devuelto.

    • code: Código del error. Un valor de cero indica que no ha habido error.
    • info: Texto desciptivo del error.

set_computer_tags

Pertenece a la API Privada.

Necesita firmar con KEY de Version.

Asigna las etiquetas al ordenador y como resultado se obtiene los paquetes que deben instalarse y desinstalarse en función de las etiquetas que anteriormente tuviera asignadas el equipo.

API Private Data Input

  • tags: Lista de Etiquetas a asignar al Ordenador

API Private Data Output

  • packages: Diccionario con la listas de paquetes.

    • preinstall: Lista de nombres de paquetes separados por espacios obtenidos del campo default preinstall packages
    • install: Lista de nombres de paquetes separados por espacios obtenidos del campo default install packages
    • remove:Lista de nombres de paquetes separados por espacios obtenidos del campo default remove packages
  • errmfs: Diccionario con el posible error devuelto.

    • code: Código del error. Un valor de cero indica que no ha habido error.
    • info: Texto desciptivo del error.

get_device

Pendiente de implementar.

get_assist_devices

Pendiente de implementar.

install_device

Pendiente de implementar.

remove_device

Pendiente de implementar.

GNU Free Documentation License

Version 1.3, 3 November 2008

Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
<http://fsf.org/>

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.

  1. 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.

The “publisher” means any person or entity that distributes copies of the Document to the public.

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.

  1. 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.

  1. 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.

  1. 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.

  1. 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”.

  1. 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.

  1. 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 in 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.

  1. 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 Warranty 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.

  1. TERMINATION

You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.

However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.

  1. 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. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.

  1. RELICENSING

“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A “Massive Multiauthor Collaboration” (or “MMC”) contained in the site means any set of copyrightable works thus published on the MMC site.

“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.

“Incorporate” means to publish or republish a Document, in whole or in part, as part of another Document.

An MMC is “eligible for relicensing” if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.

The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.

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.3 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.