Merge lp:~evilnick/maas/man-pages into lp:~maas-committers/maas/trunk

Proposed by Nick Veitch
Status: Merged
Approved by: Nick Veitch
Approved revision: 1333
Merged at revision: 1354
Proposed branch: lp:~evilnick/maas/man-pages
Merge into: lp:~maas-committers/maas/trunk
Diff against target: 186 lines (+96/-55)
5 files modified
docs/conf.py (+4/-0)
docs/man/maas-cli.8.rst (+3/-1)
docs/man/maas-import-pxe-files.8.rst (+48/-0)
docs/man/maas.8.rst (+41/-0)
man/maas-import-pxe-files.8 (+0/-54)
To merge this branch: bzr merge lp:~evilnick/maas/man-pages
Reviewer Review Type Date Requested Status
Gavin Panella (community) Approve
Review via email: mp+134878@code.launchpad.net

Commit message

adds source files for remaining man pages (maas, maas-import-pxe-files)

Description of the change

This is the final part to address bug #975454

It adds sphinx source files for man pages for maas-import-pxe-files and the maas command. These are built by
the 'make man' part of the main makefile and placed into the man directory for installation.

To post a comment you must log in.
Revision history for this message
Gavin Panella (allenap) wrote :

Looks good. I have some more things for bug 975454 so don't close it yet.

review: Approve
Revision history for this message
Nick Veitch (evilnick) wrote :

Cool. okay. Some hints as to what they might be would help :)
I think this bug is pretty much done. That isn't to say I don't have stuff to add to the docs, but in the sense that there is documentation and there are man pages. I think I would prefer specific bugs for other things

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== modified file 'docs/conf.py'
--- docs/conf.py 2012-11-08 12:55:51 +0000
+++ docs/conf.py 2012-11-19 11:55:27 +0000
@@ -230,6 +230,10 @@
230# (source start file, name, description, authors, manual section).230# (source start file, name, description, authors, manual section).
231man_pages = [231man_pages = [
232 ('man/maas-cli.8', 'maas-cli', u'MAAS API commandline utility',232 ('man/maas-cli.8', 'maas-cli', u'MAAS API commandline utility',
233 [u'Canonical 2012'], 8),
234 ('man/maas-import-pxe-files.8', 'maas-import-pxe-files', u'MAAS helper script',
235 [u'Canonical 2012'], 8),
236 ('man/maas.8', 'maas', u'MAAS administration tool',
233 [u'Canonical 2012'], 8)237 [u'Canonical 2012'], 8)
234]238]
235239
236240
=== modified file 'docs/man/maas-cli.8.rst'
--- docs/man/maas-cli.8.rst 2012-10-25 13:38:22 +0000
+++ docs/man/maas-cli.8.rst 2012-11-19 11:55:27 +0000
@@ -21,6 +21,8 @@
21^^^^^^^^^^^^^^^^^^^^^21^^^^^^^^^^^^^^^^^^^^^
22For more documentation of MAAS, please see https://maas.ubuntu.com/docs22For more documentation of MAAS, please see https://maas.ubuntu.com/docs
2323
2424See Also
25^^^^^^^^
26`maas`, `maas-import-pxe-files`
2527
2628
2729
=== added file 'docs/man/maas-import-pxe-files.8.rst'
--- docs/man/maas-import-pxe-files.8.rst 1970-01-01 00:00:00 +0000
+++ docs/man/maas-import-pxe-files.8.rst 2012-11-19 11:55:27 +0000
@@ -0,0 +1,48 @@
1maas-import-pxe-files
2---------------------
3
4USAGE
5^^^^^
6
7maas-import-pxe-files [-h, --help]
8
9DESCRIPTION
10^^^^^^^^^^^
11
12This is a helper script for the MAAS software. It downloads Ubuntu
13images and organises them for use by MAAS in commissioning nodes.
14The script is usually run regularly by a cron task, though it
15needs to be run manually the first time a MAAS system is installed.
16Images that are already in place are kept unchanged, unless the
17version in the archive has since been updated.
18
19The script reads a configuration file /etc/maas/import_pxe_files in
20order to determine:
21
22**ARCHIVE:** Location of the Ubuntu download archive
23
24**RELEASES:** Ubuntu releases to download
25
26**ARCHES:** Architectures for which images should be downloaded
27
28To support development setups that run directly from a code branch, it will
29also look for /etc/maas/import_pxe_files relative to the current
30directory.
31
32The script uses `wget` to download the kernel and initrd image for
33each architecture in ARCHES and each release in RELEASES. In addition it
34copies the Intel-architecture pre-boot loader `pxelinux.0` (plus some
35of its modules such as `chain.c32`) from its installed location in
36/usr/lib/syslinux/.
37
38These images are the minimum that's required to start installing a node.
39During installation, a node may download its packages over the network.
40
41
42Further Documentation
43^^^^^^^^^^^^^^^^^^^^^
44For more documentation of MAAS, please see https://maas.ubuntu.com/docs
45
46See Also
47^^^^^^^^
48`maas`, `maas-cli`
049
=== added file 'docs/man/maas.8.rst'
--- docs/man/maas.8.rst 1970-01-01 00:00:00 +0000
+++ docs/man/maas.8.rst 2012-11-19 11:55:27 +0000
@@ -0,0 +1,41 @@
1maas
2----
3
4USAGE
5^^^^^
6
7maas [-h, --help] createsuperuser | changepassword | shell
8
9DESCRIPTION
10^^^^^^^^^^^
11
12The `maas` command is part of Canonical's Metal As A Service software. It is
13derived from and can be used similarly to the `django-admin` command, and must
14be run with root privileges.
15
16For the end user, there are only three subcommands of interest.
17
18**createsuperuser**
19 This subcommand is used to create a superuser for the
20 MAAS install. The suggested username is "root". This command usually only
21 needs to be run when installing MAAS for the first time.
22
23**changepassword**
24 This subcommand is used to change the superuser password
25 for the MAAS install. You will be prompted to enter a new password, and then
26 enter it once again to verify.
27
28**shell**
29 This subcommand may be useful for debugging installed systems. It
30 will open a new python shell environment with the correct django environment
31 for working with the installed MAAS software.
32
33
34Further Documentation
35^^^^^^^^^^^^^^^^^^^^^
36For more documentation of MAAS, please see https://maas.ubuntu.com/docs
37
38See Also
39^^^^^^^^
40`maas-cli`, `maas-import-pxe-files`
41
042
=== removed file 'man/maas-import-pxe-files.8'
--- man/maas-import-pxe-files.8 2012-08-30 13:09:12 +0000
+++ man/maas-import-pxe-files.8 1970-01-01 00:00:00 +0000
@@ -1,54 +0,0 @@
1.TH maas\-import\-pxe-files 8 "16 July 2012" maas "maas"
2.SH NAME
3\fBmaas\-import\-pxe-files\fP \- import Ubuntu install images into MAAS
4
5.SH DESCRIPTION
6\fBmaas\-import\-pxe\-files\fP downloads Ubuntu images and installs them into
7MAAS. The MAAS server needs these images to provides nodes with operating
8systems. Images that are already in place are kept unchanged, unless the
9version in the archive has since been updated.
10
11The script reads a configuration file \fI/etc/maas/import_pxe_files\fP in
12order to determine:
13 - ARCHIVE: Location of the Ubuntu download archive
14 - RELEASES: Ubuntu releases to download
15 - ARCHES: Architectures for which images should be downloaded
16
17(To support development setups that run directly from a code branch, it will
18also look for \fIetc/maas/import_pxe_files\fP relative to the current
19directory).
20
21The script uses \fBwget\fP(1) to download the kernel and initrd image for
22each architecture in ARCHES and each release in RELEASES. In addition it
23copies the Intel-architecture pre-boot loader \fBpxelinux.0\fP (plus some
24of its modules such as \fBchain.c32\fP) from its installed location in
25\fI/usr/lib/syslinux/\fP.
26
27These images are the minimum that's required to start installng a node.
28During installation, a node may download its packages over the network.
29
30A \fBcron\fP(8) job typically runs this script at a quiet time every Sunday,
31but you may need to run it manually once for a new MAAS installation.
32
33.SH FILES
34\fI/etc/maas/import_pxe_files\fP, \fI/etc/cron.d/maas\-import\-pxe\-files\fP
35
36.SH "SEE ALSO"
37.BR maas\-import\-ephemerals (8),
38.BR cron (8),
39.BR wget (1)
40
41.TP
42\fIhttp://launchpad.net/maas\fP
43.PD
44
45.SH AUTHOR
46This manual page and the script were written by Jeroen Vermeulen
47<jeroen.vermeulen@canonical.com> for Ubuntu systems, but may be used by
48others. Permission is granted to copy, distribute and/or modify this
49document and the utility under the terms of the GNU General Public
50License, Version 3 published by the Free Software Foundation.
51
52The complete text of the GNU General Public License can be found in
53\fI/usr/share/common-licenses/GPL\fP on Debian/Ubuntu systems, or on
54the web at \fIhttp://www.gnu.org/licenses/gpl.txt\fP.