]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/dev: update essentials.rst 38057/head
authorZac Dover <zac.dover@gmail.com>
Fri, 13 Nov 2020 07:37:58 +0000 (17:37 +1000)
committerZac Dover <zac.dover@gmail.com>
Fri, 13 Nov 2020 07:56:05 +0000 (17:56 +1000)
This commit changes the noun "backup" to the
intended verb "back up" (this is one of my
technical documentation pet peeves and I couldn't
resist), and it also removes the verb "to nuke"
and replaces it with something less poetic but
more likely to be discoverable in a dictionary by
someone whose English is weak. It also adds a
missing colon.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
doc/dev/developer_guide/essentials.rst

index 4cca851d97e174e4b6ae412e5ff673b5eb0b3f0f..092daeaca795f4beda3d1ecfb81bf684c495deea 100644 (file)
@@ -182,9 +182,9 @@ Cleaning the Source Tree
 
   make clean
   
-.. note:: The following command will nuke everything in the source tree that
-          isn't tracked by git, so make sure to backup any log files or conf 
-          options.
+.. note:: The following commands will remove everything in the source tree 
+          that isn't tracked by git. Make sure to back up your log files 
+          and configuration options before running these commands.
 
 .. prompt:: bash $
 
@@ -222,7 +222,7 @@ configuration file ``ccache.conf``::
 
 Now, set the environment variable ``SOURCE_DATE_EPOCH`` to a fixed value (a
 UNIX timestamp) and set ``ENABLE_GIT_VERSION`` to ``OFF`` when running
-``cmake``
+``cmake``:
 
 .. prompt:: bash $