A few documentation fixes

HACKING.txt → HACKING.rst

@@ -277,11 +277,11 @@ contents of the snap, but it's in a plain directory insted of in a
 squashfs image. Using a directory is better for testing, since you can
 change the files in there and not rebuild the snap.
 
-There's a dev-snap-sync make target to automate this:
+There's a ``sync-dev-snap`` make target to automate this:
 
-    $ make dev-snap-sync
+    $ make sync-dev-snap
 
-The dev-snap-sync target creates a clean copy of your working tree (so
+The ``sync-dev-snap`` target creates a clean copy of your working tree (so
 that you don't have to run 'make clean' before building the snap) in
 build/dev-snap and creates the snap directory in build/dev-snap/prime.
 
@@ -302,10 +302,10 @@ Next you need to initialize the snap, just like you would normally do:
     $ sudo maas init
 
 And now you're ready to make changes to the code. After you've change
-some source files and want to test them out, run the dev-snap-sync
+some source files and want to test them out, run the ``sync-dev-snap``
 target again:
 
-    $ make dev-snap-sync
+    $ make sync-dev-snap
 
 You should now see that you files were synced to the prime directory. If
 you changed JS and HTML files only, you should see that changes straight

README → README.rst

@@ -1,5 +1,3 @@
-.. -*- mode: rst -*-
-
 ************************
 MAAS: Metal as a Service
 ************************

docs/hacking.rst

@@ -1 +1 @@
-../HACKING.txt
+../HACKING.rst

media/README.rst

@@ -0,0 +1,5 @@
+This folder contains somewhat ephemeral things: subfolders serve as
+``MEDIA_ROOT`` for `demo` and `development` environments. The ``media/demo``
+directory should always exist and not be deleted, though its contents can
+be. The ``media/development.$$`` (where ``$$`` is the PID of the running process)
+directories are created and destroyed by tests, as needed.

services/README → services/README.rst

@@ -2,5 +2,5 @@ The development environment uses *daemontools* to manage the various
 services that are required. These are all defined in subdirectories in
 ``services/``.
 
-See the paragraph 'Development services' in HACKING.txt for more
+See the paragraph 'Development services' in HACKING.rst for more
 information.

setup.py

@@ -74,7 +74,7 @@ def run(self):
     url="https://launchpad.net/maas",
     license="AGPLv3",
     description="Metal As A Service",
-    long_description=read('README'),
+    long_description=read('README.rst'),
 
     author="MAAS Developers",
     author_email="maas-devel@lists.launchpad.net",

src/maasserver/api/tests/test_filestorage.py

@@ -35,7 +35,7 @@ def setUp(self):
         super(MediaRootFixture, self).setUp()
         self.path = settings.MEDIA_ROOT
         if os.path.exists(self.path):
-            raise AssertionError("See media/README")
+            raise AssertionError("See media/README.rst")
         self.addCleanup(shutil.rmtree, self.path, ignore_errors=True)
         os.mkdir(self.path)
 

src/provisioningserver/rackdservices/dhcp_probe_service.py

@@ -137,7 +137,7 @@ def probe_dhcp(self):
                     "Failed to probe for external DHCP servers on interface "
                     "'%s'." % interface)
                 if is_dev_environment():
-                    error += " (Did you configure authbind per HACKING.txt?)"
+                    error += " (Did you configure authbind per HACKING.rst?)"
                 self.err(e, error)
                 continue
             else:

utilities/configure-lxd-profile

@@ -62,6 +62,9 @@ else
          lxc.cgroup.devices.allow = b 7:* rwm
          lxc.cgroup.devices.allow = c 10:237 rwm"
     lxc profile set $PROFILE security.privileged true
+    lxc profile show $PROFILE  |
+        sed 's/^description:.*/description: MAAS development profile/' |
+        lxc profile edit $PROFILE
 fi
 
 ##

utilities/maas-region-support-dump

@@ -6,7 +6,7 @@ PSQL_ARGS="maasdb"
 SUDO_ARGS="sudo -u postgres"
 
 # Detect a development environment
-if [ -d ../db -a -f ../HACKING.txt ]; then
+if [ -d ../db -a -f ../HACKING.rst ]; then
     echo "Using development database."
     cd ..
     SUDO_ARGS=""