Просмотр исходного кода

docs: minor formatting changes in development docs

Thomas Waldmann 3 недель назад
Родитель
Сommit
b6ee18fffc
1 измененных файлов с 10 добавлено и 15 удалено
  1. 10 15
      docs/development.rst

+ 10 - 15
docs/development.rst

@@ -226,7 +226,6 @@ We use `black`_ for automatically formatting the code.
 If you work on the code, it is recommended that you run black **before each commit**
 If you work on the code, it is recommended that you run black **before each commit**
 (so that new code is always using the desired formatting and no additional commits
 (so that new code is always using the desired formatting and no additional commits
 are required to fix the formatting).
 are required to fix the formatting).
-
 ::
 ::
 
 
     pip install -r requirements.d/codestyle.txt     # everybody use same black version
     pip install -r requirements.d/codestyle.txt     # everybody use same black version
@@ -281,7 +280,6 @@ will have to be installed separately. Run this command to install the pre-commit
 
 
   pre-commit install
   pre-commit install
 
 
-
 Running the tests
 Running the tests
 -----------------
 -----------------
 
 
@@ -289,7 +287,7 @@ The tests are in the borg/testsuite package.
 
 
 To run all the tests, you need to have fakeroot installed. If you do not have
 To run all the tests, you need to have fakeroot installed. If you do not have
 fakeroot, you still will be able to run most tests, just leave away the
 fakeroot, you still will be able to run most tests, just leave away the
-`fakeroot -u` from the given command lines.
+``fakeroot -u`` from the given command lines.
 
 
 To run the test suite use the following command::
 To run the test suite use the following command::
 
 
@@ -312,13 +310,13 @@ Important notes:
 
 
 - When using ``--`` to give options to py.test, you MUST also give ``borg.testsuite[.module]``.
 - When using ``--`` to give options to py.test, you MUST also give ``borg.testsuite[.module]``.
 
 
-
 Running the tests (using the pypi package)
 Running the tests (using the pypi package)
 ------------------------------------------
 ------------------------------------------
 
 
 Since borg 1.4, it is also possible to run the tests without a development
 Since borg 1.4, it is also possible to run the tests without a development
 environment, using the borgbackup dist package (downloaded from pypi.org or
 environment, using the borgbackup dist package (downloaded from pypi.org or
-github releases page)::
+github releases page):
+::
 
 
     # optional: create and use a virtual env:
     # optional: create and use a virtual env:
     python3 -m venv env
     python3 -m venv env
@@ -331,7 +329,6 @@ github releases page)::
     # run the tests
     # run the tests
     pytest -v -rs --benchmark-skip --pyargs borg.testsuite
     pytest -v -rs --benchmark-skip --pyargs borg.testsuite
 
 
-
 Adding a compression algorithm
 Adding a compression algorithm
 ------------------------------
 ------------------------------
 
 
@@ -408,7 +405,6 @@ Usage::
    # To copy files from the VM (in this case, the generated binary):
    # To copy files from the VM (in this case, the generated binary):
    vagrant scp OS:/vagrant/borg/borg.exe .
    vagrant scp OS:/vagrant/borg/borg.exe .
 
 
-
 Creating standalone binaries
 Creating standalone binaries
 ----------------------------
 ----------------------------
 
 
@@ -427,7 +423,6 @@ If you encounter issues, see also our `Vagrantfile` for details.
           work on same OS, same architecture (x86 32bit, amd64 64bit)
           work on same OS, same architecture (x86 32bit, amd64 64bit)
           without external dependencies.
           without external dependencies.
 
 
-
 .. _releasing:
 .. _releasing:
 
 
 Creating a new release
 Creating a new release
@@ -485,16 +480,16 @@ Checklist:
   new version number and release date.
   new version number and release date.
 - Announce on:
 - Announce on:
 
 
- - Mailing list.
- - Mastodon / BlueSky / X (aka Twitter).
- - IRC channel (change ``/topic``).
+  - Mailing list.
+  - Mastodon / BlueSky / X (aka Twitter).
+  - IRC channel (change ``/topic``).
 
 
 - Create a GitHub release, include:
 - Create a GitHub release, include:
 
 
-  * pypi dist package and signature
-  * Standalone binaries (see above for how to create them).
+  - pypi dist package and signature
+  - Standalone binaries (see above for how to create them).
 
 
-    + For macOS, document the macFUSE version in the README of the binaries.
+    - For macOS, document the macFUSE version in the README of the binaries.
       macFUSE uses a kernel extension that needs to be compatible with the
       macFUSE uses a kernel extension that needs to be compatible with the
       code contained in the binary.
       code contained in the binary.
-  * A link to ``CHANGES.rst``.
+  - A link to ``CHANGES.rst``.