From cbdb59af8e7a1b40d687f80e62c5892686d384d2 Mon Sep 17 00:00:00 2001
From: Mathieu Lirzin <mthl@gnu.org>
Date: Fri, 2 Dec 2016 15:57:06 +0100
Subject: doc: Add Cuirass manual.

* doc/cuirass.texi: New file.
* doc/fdl-1.3.texi: Likewise.
* Makefile.am (info_TEXINFOS, doc_cuirass_TEXINFOS): New variables.
* dir-locals.el: Use the American dictionary for Texinfo mode.
* .gitignore: Update.
---
 doc/cuirass.texi | 140 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 140 insertions(+)
 create mode 100644 doc/cuirass.texi

(limited to 'doc/cuirass.texi')

diff --git a/doc/cuirass.texi b/doc/cuirass.texi
new file mode 100644
index 0000000..9bb84d4
--- /dev/null
+++ b/doc/cuirass.texi
@@ -0,0 +1,140 @@
+\input texinfo
+@setfilename cuirass.info
+@documentencoding UTF-8
+@include version.texi
+@settitle Cuirass Reference Manual
+@setchapternewpage odd
+
+@copying
+
+This manual is for Cuirass version @value{VERSION}, a continuous
+integration tool using GNU Guix functional package manager.
+
+Copyright @copyright{} 2016 Mathieu Lirzin
+
+@quotation
+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''.
+@end quotation
+@end copying
+
+@dircategory System administration
+@direntry
+* Cuirass: (cuirass).       Reproducible Continuous Integration.
+@end direntry
+
+@titlepage
+@title Cuirass Reference Manual
+@subtitle Reproducible Continuous Integration.
+@subtitle @value{UPDATED}, Cuirass Version @value{VERSION}
+@author by Mathieu Lirzin
+
+@page
+@vskip 0pt plus 1filll
+@insertcopying
+@end titlepage
+
+@contents
+
+@ifnottex
+@node Top
+@top Cuirass
+@insertcopying
+@end ifnottex
+
+@c *********************************************************************
+@menu
+* Introduction::                What is Cuirass about?
+* Continuous Integration::      A practical solution
+* Invocation::                  How to run Cuirass.
+* Contributing::                Your help needed!
+* GNU Free Documentation License::  The license of this manual.
+* Concept Index::               Concepts.
+
+@end menu
+
+@c *********************************************************************
+@node Introduction
+@chapter Introduction
+
+@c *********************************************************************
+@node Continuous Integration
+@chapter Continuous Integration
+
+@c *********************************************************************
+@node Invocation
+@chapter Invoking cuirass
+@cindex invoking cuirass
+@cindex cuirass invocation
+@cindex options for invoking cuirass
+
+The usual way to invoke @code{cuirass} is as follows:
+
+@example
+cuirass --specifications @var{specs}
+@end example
+
+Additionally the following options can be used.
+
+@table @code
+@item --one-shot
+Instead of executing @code{cuirass} as a daemon looping over the jobs.
+Only evaluate and build the specifications once.
+
+@item --cache-directory=@var{directory}
+@var{directory} is the place where the VCS repositories used by the jobs
+are stored.
+
+@item --specifications=@var{specifications-file}
+@itemx -S @var{specifications-file}
+Add the specifications defined in @var{specifications-file} in the job
+database before launching the evaluation and build processes.
+
+@item --database=@var{database}
+@itemx -D @var{database}
+Use @var{database} as the database containing the jobs and the past
+build results. Since @code{cuirass} uses SQLite as a database engine,
+@var{database} must be a file name.  If the file doesn't exist, it will
+be created.
+
+@item --interval=@var{n}
+@itemx -I @var{n}
+Wait @var{n} seconds between each poll.
+
+@item --use-substitutes
+This can be useful when you are not interested in building the
+dependencies of a particular job.
+
+@item --version
+@itemx -V
+Display the actual version of @code{cuirass}.
+
+@item --help
+@itemx -h
+Display an help message that summarize all the options provided.
+@end table
+
+@c *********************************************************************
+@node Contributing
+@chapter Contributing
+
+Everyone is welcome to contribute to Cuirass.  You can send patches and
+share your ideas at @email{guix-devel@@gnu.org} or contact directly the
+maintainer at @email{mthl@@gnu.org}.
+
+@c *********************************************************************
+@node GNU Free Documentation License
+@appendix GNU Free Documentation License
+@cindex license, GNU Free Documentation License
+@include fdl-1.3.texi
+
+@c *********************************************************************
+@node Concept Index
+@unnumbered Concept Index
+@printindex cp
+
+@bye
-- 
cgit v1.2.3