You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/pages/using.rst
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -321,14 +321,14 @@ Analyzing a repository whose git service is not supported by Macaron
321
321
If the repository remote URL is from an unknown git service (see :ref:`Git Services <supported_git_services>` for a list of supported git services in Macaron), Macaron won't recognize it when analyzing the repository.
322
322
323
323
You would need to tell Macaron about that git service through the ``defaults.ini`` config.
324
-
For example, let's say you want to analyze the Bitbucket repository at ``https://bitbucket.org/snakeyaml/snakeyaml``. First, you need to create a ``defaults.ini`` file in the current workspace with the following content:
324
+
For example, let's say you want to analyze a repository hosted at ``https://git.example.com/foo/target``. First, you need to create a ``defaults.ini`` file in the current workspace with the following content:
325
325
326
326
.. code-block:: ini
327
327
328
328
[git_service.local_repo]
329
-
hostname = bitbucket.org
329
+
hostname = git.example.com
330
330
331
-
In which ``hostname`` contains the domain of the git service URL. In this example it's ``bitbucket.org``.
331
+
In which ``hostname`` contains the domain of the git service URL. In this example it's ``git.example.com``.
332
332
333
333
.. note::
334
334
@@ -340,17 +340,17 @@ Assume that the dir tree at the current workspace has the following structure:
340
340
341
341
boo
342
342
├── foo
343
-
│ └── snakeyaml
343
+
│ └── target
344
344
345
-
We can run Macaron against the local repository at ``snakeyaml`` by using this command:
345
+
We can run Macaron against the local repository at ``target`` by using this command:
With ``rest_of_args`` being the arguments to the ``analyze`` command (e.g. ``-b``, ``-d`` or ``--skip-deps`` similar to two previous examples).
352
352
353
-
The ``-lr`` flag tells Macaron to look into ``path/to/boo/foo`` for local repositories. For more information, please see :ref:`Command Line Usage <cli-usage>`.
353
+
The ``-lr`` flag tells Macaron to look into ``./boo/foo`` for local repositories. For more information, please see :ref:`Command Line Usage <cli-usage>`.
354
354
355
355
.. note:: If ``-lr`` is not provided, Macaron will looks inside ``<current_working_directory>/output/git_repos/local_repos/`` whenever you provide a local path to ``-rp``.
356
356
@@ -376,7 +376,7 @@ We can run Macaron against the local repository at ``target`` by using this comm
376
376
377
377
With ``rest_of_args`` being the arguments to the ``analyze`` command (e.g. ``-b``, ``-d`` or ``--skip-deps`` similar to two previous examples).
378
378
379
-
The ``-lr`` flag tells Macaron to look into ``path/to/boo/foo`` for local repositories. For more information, please see :ref:`Command Line Usage <cli-usage>`.
379
+
The ``-lr`` flag tells Macaron to look into ``./boo/foo`` for local repositories. For more information, please see :ref:`Command Line Usage <cli-usage>`.
380
380
381
381
.. note:: If ``-lr`` is not provided, Macaron will looks inside ``<current_working_directory>/output/git_repos/local_repos/`` whenever you provide a local path to ``-rp``.
0 commit comments