Merge lp:~evilnick/maas/rm-import-pxe-references into lp:~maas-committers/maas/trunk

[Nick Veitch]

Removing references to maas-import-pxe-files from the docs and man pages

removed references to maas-import-pxe files in the text
removed the man page for maas-import-pxe-files
tidied up the Makefile

[Gavin Panella (allenap)]

[1]

In Makefile, can you change:

+ $(RM) man/*

to:

       $(RM) -r man

(It's what the Daleks would chant if they knew Unix.)

review: Approve

[Nick Veitch (evilnick)]

On 20/11/12 20:44, Gavin Panella wrote:
> Review: Approve
>
> [1]
>
> In Makefile, can you change:
>
> + $(RM) man/*
>
> to:
>
> $(RM) -r man
>
> (It's what the Daleks would chant if they knew Unix.)
>
sure, i didn't know if we wanted to remove the directory or not

--
Nick Veitch,
Technical Writer, Cloud Engineering, Canonical
https://launchpad.net/~evilnick

=== modified file '.bzrignore'
--- .bzrignore	2012-09-03 17:35:47 +0000
+++ .bzrignore	2012-11-21 10:28:58 +0000
@@ -31,3 +31,4 @@
 ./TAGS
 ./tags
 dropin.cache
+./man

=== modified file 'INSTALL.txt'
--- INSTALL.txt	2012-10-04 15:14:12 +0000
+++ INSTALL.txt	2012-11-21 10:28:58 +0000
@@ -144,15 +144,16 @@
 ----------------------
 
 MAAS will check for and download new Ubuntu images once a week.
-However, you'll need to download them manually the first time::
-
-  $ sudo maas-import-pxe-files
-
-If you are using an HTTP proxy, bear in mind that the "sudo" will not
-pass your http_proxy environment variable on to the script.  If that is
-a problem, pass it on explicitly::
-
-  $ sudo http_proxy=$http_proxy maas-import-pxe-files
+However, you'll need to download them manually the first time. To do this you will need to
+connect to the MAAS API using the maas-cli tool. (see :ref:`api_key` for details of logging 
+in).
+Then you need to run the command::
+
+  $ maas-cli maas node-groups import-boot-images
+
+(substitute in a different profile name for 'maas' if you have called yours something else)
+This will initiate downloading the required image files. Note that this may take some time 
+depending on your network connection.
 
 
 Login to the server

=== modified file 'Makefile'
--- Makefile	2012-10-25 15:26:16 +0000
+++ Makefile	2012-11-21 10:28:58 +0000
@@ -159,6 +159,7 @@
 	$(RM) celerybeat-schedule
 	$(RM) docs/api.rst
 	$(RM) -r docs/_autosummary
+	$(RM) -r man/
 
 distclean: clean stop
 	$(RM) -r bin include lib local

=== modified file 'docs/man/maas-cli.8.rst'
--- docs/man/maas-cli.8.rst	2012-11-19 11:39:07 +0000
+++ docs/man/maas-cli.8.rst	2012-11-21 10:28:58 +0000
@@ -23,6 +23,6 @@
 
 See Also
 ^^^^^^^^
-`maas`, `maas-import-pxe-files`
+`maas`
 
 

=== 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-21 10:28:58 +0000
@@ -0,0 +1,51 @@
+maas-import-pxe-files
+---------------------
+
+USAGE
+^^^^^
+
+maas-import-pxe-files [-h, --help]
+
+DESCRIPTION
+^^^^^^^^^^^
+
+This is a helper script for the MAAS software. It downloads Ubuntu 
+images and organises them for use by MAAS in commissioning nodes.
+The script is usually run regularly by a cron task, though it 
+needs to be run manually the first time a MAAS system is installed.
+Images that are already in place are kept unchanged, unless the
+version in the archive has since been updated.
+
+The script reads a configuration file /etc/maas/import_pxe_files in
+order to determine:
+
+**ARCHIVE:** 
+Location of the Ubuntu download archive
+
+**RELEASES:** 
+Ubuntu releases to download
+
+**ARCHES:** 
+Architectures for which images should be downloaded
+
+To support development setups that run directly from a code branch, 
+it will also look for /etc/maas/import_pxe_files relative to the 
+current directory.
+
+The script uses `wget` to download the kernel and initrd image for
+each architecture in ARCHES and each release in RELEASES.  In addition 
+it copies the Intel-architecture pre-boot loader `pxelinux.0` (plus 
+some of its modules such as `chain.c32`) from its installed location in
+/usr/lib/syslinux/.
+
+These images are the minimum that's required to start installing a node.
+During installation, a node may download its packages over the network.
+
+
+Further Documentation
+^^^^^^^^^^^^^^^^^^^^^
+For more documentation of MAAS, please see https://maas.ubuntu.com/docs
+
+See Also
+^^^^^^^^
+`maas`, `maas-cli`

=== removed file 'docs/man/maas-import-pxe-files.8.rst'
--- docs/man/maas-import-pxe-files.8.rst	2012-11-19 11:44:17 +0000
+++ docs/man/maas-import-pxe-files.8.rst	1970-01-01 00:00:00 +0000
@@ -1,48 +0,0 @@
-maas-import-pxe-files
----------------------
-
-USAGE
-^^^^^
-
-maas-import-pxe-files [-h, --help]
-
-DESCRIPTION
-^^^^^^^^^^^
-
-This is a helper script for the MAAS software. It downloads Ubuntu 
-images and organises them for use by MAAS in commissioning nodes.
-The script is usually run regularly by a cron task, though it 
-needs to be run manually the first time a MAAS system is installed.
-Images that are already in place are kept unchanged, unless the
-version in the archive has since been updated.
-
-The script reads a configuration file /etc/maas/import_pxe_files in
-order to determine:
-
-**ARCHIVE:** Location of the Ubuntu download archive
-
-**RELEASES:** Ubuntu releases to download
-
-**ARCHES:** Architectures for which images should be downloaded
-
-To support development setups that run directly from a code branch, it will
-also look for /etc/maas/import_pxe_files relative to the current
-directory.
-
-The script uses `wget` to download the kernel and initrd image for
-each architecture in ARCHES and each release in RELEASES.  In addition it
-copies the Intel-architecture pre-boot loader `pxelinux.0` (plus some
-of its modules such as `chain.c32`) from its installed location in
-/usr/lib/syslinux/.
-
-These images are the minimum that's required to start installing a node.
-During installation, a node may download its packages over the network.
-
-
-Further Documentation
-^^^^^^^^^^^^^^^^^^^^^
-For more documentation of MAAS, please see https://maas.ubuntu.com/docs
-
-See Also
-^^^^^^^^
-`maas`, `maas-cli`

=== modified file 'docs/man/maas.8.rst'
--- docs/man/maas.8.rst	2012-11-19 11:40:18 +0000
+++ docs/man/maas.8.rst	2012-11-21 10:28:58 +0000
@@ -37,5 +37,5 @@
 
 See Also
 ^^^^^^^^
-`maas-cli`, `maas-import-pxe-files`
+`maas-cli`
 

=== removed directory 'man'