Skip to content
Snippets Groups Projects
Unverified Commit cbdb59af authored by Mathieu Lirzin's avatar Mathieu Lirzin
Browse files

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.
parent 05eba838
No related branches found
No related tags found
No related merge requests found
;; Per-directory local variables for GNU Emacs 23 and later.
;;; Directory Local Variables
;;; For more information see (info "(emacs) Directory Variables")
((nil
. ((fill-column . 78)
(tab-width . 8)
;; For use with 'bug-reference-prog-mode'.
(bug-reference-url-format . "http://bugs.gnu.org/%s")
(bug-reference-bug-regexp
. "<https?://\\(debbugs\\|bugs\\)\\.gnu\\.org/\\([0-9]+\\)>")))
(fill-column . 78)
(tab-width . 8)
(bug-reference-url-format . "http://bugs.gnu.org/%s")
(bug-reference-bug-regexp
. "<https?://\\(debbugs\\|bugs\\)\\.gnu\\.org/\\([0-9]+\\)>"))
(scheme-mode
.
((indent-tabs-mode . nil)
(eval . (put 'call-with-time 'scheme-indent-function 1))
(eval . (put 'test-error 'scheme-indent-function 1))
(eval . (put 'make-parameter 'scheme-indent-function 1))
(eval . (put 'with-database 'scheme-indent-function 1)))))
(indent-tabs-mode)
(eval put 'call-with-time 'scheme-indent-function 1)
(eval put 'test-error 'scheme-indent-function 1)
(eval put 'make-parameter 'scheme-indent-function 1)
(eval put 'with-database 'scheme-indent-function 1))
(texinfo-mode
(indent-tabs-mode)
(fill-column . 72)
(ispell-local-dictionary . "american")))
*.go
*.info
*.log
*.trs
.dirstamp
/*.status
/INSTALL
/aclocal.m4
......@@ -10,12 +12,16 @@
/build-aux/config.guess
/build-aux/config.sub
/build-aux/install-sh
/build-aux/mdate-sh
/build-aux/missing
/build-aux/test-driver
/build-aux/texinfo.tex
/cache/
/config.cache
/configure
/doc/version.texi
/src/cuirass/config.scm
Makefile
Makefile.in
pre-inst-env
stamp-vti
......@@ -172,6 +172,13 @@ src/cuirass/config.scm: $(srcdir)/src/cuirass/config.scm.in Makefile
# compilation.
BUILT_SOURCES = src/cuirass/config.scm
## --------------- ##
## Documentation. ##
## --------------- ##
info_TEXINFOS = doc/cuirass.texi
doc_cuirass_TEXINFOS = doc/fdl-1.3.texi
## -------------- ##
## Installation. ##
## -------------- ##
......
\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
This diff is collapsed.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment