From: Zac Dover Date: Fri, 13 Nov 2020 07:37:58 +0000 (+1000) Subject: doc/dev: update essentials.rst X-Git-Tag: v16.1.0~615^2 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=ef0a9db6685f12ad6c1ae27151afaa2190083eae;p=ceph.git doc/dev: update essentials.rst 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 --- diff --git a/doc/dev/developer_guide/essentials.rst b/doc/dev/developer_guide/essentials.rst index 4cca851d97e17..092daeaca795f 100644 --- a/doc/dev/developer_guide/essentials.rst +++ b/doc/dev/developer_guide/essentials.rst @@ -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 $