Skip to content

Commit

Permalink
#109 Add usage documentation for remote repos
Browse files Browse the repository at this point in the history
  • Loading branch information
ropapermaker committed Jun 16, 2023
1 parent b68493b commit f3f8c1c
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,30 @@ For further processing the results of pygount, ``--format=json`` should be the
easiest to deal with. For more information see :doc:`json`.


Remote repositories
-------

Pygount can analyze remote git repositories by shallow cloning to a temporary
directory:

.. code-block:: bash
$ pygount https://github.com/roskakori/pygount.git
* It supports mixing multiple URLs with or without local folders, for example:

.. code-block:: bash
$ pygount https://github.com/roskakori/pygount.git ~/development/sometool
* It supports different protocols such as Git, HTTP/S and SSH.
* The branch or tag can be specified in the URL, for example:

* ``https://github.com/roskakori/pygount.git/master``
* ``https://github.com/roskakori/pygount.git/feature/branch``
* ``git@github.com:roskakori/pygount.git/v1.6.0``


Patterns
--------

Expand All @@ -95,7 +119,7 @@ taken into account.
.. option:: --generated

So for example to specify that generated code can also contain the German word
"generiert" in a case insensivie way use
"generiert" in a case insensitive way use
``--generated="[regex][...](?i).*generiert"``.


Expand Down

0 comments on commit f3f8c1c

Please sign in to comment.