Cleanup console examples in docs

Author: spoorcc

dfetch/commands/diff.py

@@ -15,9 +15,9 @@
 
 The below statement will generate a patch for ``some-project`` from your manifest.
 
-.. code-block:: sh
+.. code-block:: console
 
-   dfetch diff some-project
+   $ dfetch diff some-project
 
 .. tabs::
 
@@ -41,15 +41,15 @@
 
     .. tab:: Git
 
-        .. code-block:: sh
+        .. code-block:: console
 
-            git apply --check formatted-some-project.patch
+            $ git apply --check formatted-some-project.patch
 
     .. tab:: SVN
 
-        .. code-block:: sh
+        .. code-block:: console
 
-            svn patch formatted-some-project.patch
+            $ svn patch formatted-some-project.patch
 
 """
 

dfetch/commands/format_patch.py

@@ -8,9 +8,9 @@
 root directory. The ``format-patch`` command reformats all patches of a project
 to make them usable for the upstream project.
 
-.. code-block:: sh
+.. code-block:: console
 
-   dfetch format-patch some-project
+   $ dfetch format-patch some-project
 
 .. tabs::
 

dfetch/commands/update_patch.py

@@ -15,9 +15,9 @@
 
 The below statement will update the patch for ``some-project`` from your manifest.
 
-.. code-block:: sh
+.. code-block:: console
 
-   dfetch update-patch some-project
+   $ dfetch update-patch some-project
 
 .. tabs::
 

dfetch/manifest/project.py

@@ -295,9 +295,9 @@
 
     .. tab:: Git
 
-        .. code-block:: sh
+        .. code-block:: console
 
-            git diff --relative=path/to/project HEAD > my_patch.patch
+            $ git diff --relative=path/to/project HEAD > my_patch.patch
 
         For more details see the `git-diff <https://git-scm.com/docs/git-diff>`_ documentation.
 
@@ -307,9 +307,9 @@
 
     .. tab:: SVN
 
-        .. code-block:: sh
+        .. code-block:: console
 
-            svn diff -r HEAD path/to/my_project > my_patch.patch
+            $ svn diff -r HEAD path/to/my_project > my_patch.patch
 
         For more details see the `svn-diff <http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.diff.html>`_ documentation.
 

doc/howto/adding-a-project.rst

@@ -57,15 +57,15 @@ Pass the repository URL to ``dfetch add`` and it will append a new entry to
 (branches and tags), selects the default branch, and guesses a destination
 path based on your existing projects.
 
-.. code-block:: sh
+.. code-block:: console
 
   $ dfetch add https://github.com/some-org/some-repo.git
 
 .. asciinema:: ../asciicasts/add.cast
 
 Override individual fields with flags:
 
-.. code-block:: sh
+.. code-block:: console
 
   $ dfetch add \
       --name mylib \
@@ -86,7 +86,7 @@ The ``--interactive`` (``-i``) flag starts a step-by-step wizard.  Use it
 when you want to browse available branches and tags, choose a sub-directory
 inside the remote repository, or configure which paths to ignore.
 
-.. code-block:: sh
+.. code-block:: console
 
   $ dfetch add -i https://github.com/some-org/some-repo.git
 
@@ -106,7 +106,7 @@ The wizard walks through each field in turn:
 
 You can pre-fill any field to skip its prompt:
 
-.. code-block:: sh
+.. code-block:: console
 
   $ dfetch add -i --version main \
                   --src lib/core \

doc/howto/check-ci.rst

@@ -25,9 +25,9 @@ Running dfetch check in CI
 Without extra flags the results are printed to stdout and the build fails if
 any issue is found:
 
-.. code-block:: sh
+.. code-block:: console
 
-    dfetch check
+    $ dfetch check
 
 Pass a ``--*-json`` flag to write a machine-readable report *and* continue
 collecting results before deciding the build outcome (each section below shows

doc/howto/patching.rst

@@ -27,9 +27,9 @@ After fetching a project with :ref:`dfetch update <update>`, make your edits
 directly in the vendored source tree.  Once you are happy with the changes,
 run:
 
-.. code-block:: sh
+.. code-block:: console
 
-    dfetch diff some-project
+    $ dfetch diff some-project
 
 *Dfetch* compares the working tree against the revision recorded in the
 metadata file and writes a patch file named ``some-project.patch`` (or
@@ -86,9 +86,9 @@ As your local edits evolve — or when the upstream version changes — the
 existing patch file may no longer apply cleanly.  Instead of manually
 regenerating it, run:
 
-.. code-block:: sh
+.. code-block:: console
 
-    dfetch update-patch some-project
+    $ dfetch update-patch some-project
 
 This regenerates the last patch for ``some-project`` from the current working
 tree, keeping the upstream revision unchanged.  It is safe to run repeatedly
@@ -116,9 +116,9 @@ directory inside your repository.  Most upstream projects expect patches to be
 relative to their own root, which is a different path.  To reformat all patches
 for a project:
 
-.. code-block:: sh
+.. code-block:: console
 
-    dfetch format-patch some-project
+    $ dfetch format-patch some-project
 
 This writes a ``formatted-some-project.patch`` file (or one file per patch if
 there are several) that is ready to attach to a pull request or send by email.
@@ -130,15 +130,15 @@ You can verify the formatted patch applies cleanly before submitting:
 
     .. tab:: Git
 
-        .. code-block:: sh
+        .. code-block:: console
 
-            git apply --check formatted-some-project.patch
+            $ git apply --check formatted-some-project.patch
 
     .. tab:: SVN
 
-        .. code-block:: sh
+        .. code-block:: console
 
-            svn patch formatted-some-project.patch
+            $ svn patch formatted-some-project.patch
 
 .. asciinema:: ../asciicasts/format-patch.cast
 

doc/howto/sbom.rst

@@ -11,7 +11,7 @@ license policy across an organisation.
 
 .. asciinema:: ../asciicasts/sbom.cast
 
-.. code-block:: sh
+.. code-block:: console
 
     $ dfetch report -t sbom -o dfetch.cdx.json
 

doc/howto/updating-projects.rst

@@ -21,7 +21,7 @@ Fetching all projects
 
 Run without arguments to fetch every project in the manifest:
 
-.. code-block:: sh
+.. code-block:: console
 
     $ dfetch update
 
@@ -53,10 +53,12 @@ Updating a single project
 
 Pass one or more project names to limit which entries are updated:
 
-.. code-block:: sh
+.. code-block:: console
 
     $ dfetch update mylib
 
+.. code-block:: console
+
     $ dfetch update mylib myother
 
 .. _updating-force:
@@ -68,7 +70,7 @@ By default *Dfetch* skips a project that is already at the requested version
 or that has local modifications.  Use ``--force`` (``-f``) to re-fetch and
 overwrite regardless:
 
-.. code-block:: sh
+.. code-block:: console
 
     $ dfetch update --force mylib
 
@@ -89,7 +91,7 @@ decide whether to vendor those as well.
 
 To skip this check entirely:
 
-.. code-block:: sh
+.. code-block:: console
 
     $ dfetch update --no-recommendations
 
@@ -105,7 +107,11 @@ automatically — no extra manifest entries or ``git submodule`` commands are
 needed.  Each submodule is checked out at the exact revision pinned by the
 parent repository::
 
-   Dfetch (0.12.1)
+.. code-block:: console
+
+     $ dfetch update
+
+     Dfetch (0.13.0)
      my-project:
      > Found & fetched submodule "./ext/vendor-lib"  (https://github.com/example/vendor-lib @ master - 79698c9…)
      > Fetched master - e1fda19…

doc/tutorials/getting_started.rst

@@ -62,7 +62,9 @@ Make sure that you have installed *Dfetch* as described in :ref:`Installation`.
 
 From a command-line perform the following command::
 
-   dfetch update
+.. code-block:: console
+
+  $ dfetch update
 
 *Dfetch* will search through all directories down until it finds the ``dfetch.yaml``
 manifest and it will perform the update.