Skip to content

Commit a05ef37

Browse files
author
Trong Nhan Mai
committed
chore: update example and include minor fix
1 parent 4d9adda commit a05ef37

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/source/pages/using.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -321,14 +321,14 @@ Analyzing a repository whose git service is not supported by Macaron
321321
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.
322322

323323
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:
325325

326326
.. code-block:: ini
327327
328328
[git_service.local_repo]
329-
hostname = bitbucket.org
329+
hostname = git.example.com
330330
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``.
332332

333333
.. note::
334334

@@ -340,17 +340,17 @@ Assume that the dir tree at the current workspace has the following structure:
340340
341341
boo
342342
├── foo
343-
│ └── snakeyaml
343+
│ └── target
344344
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:
346346

347347
.. code-block:: shell
348348
349-
./run_macaron.sh --local-repos-path ./boo/foo --defaults-path ./defaults.ini analyze -rp snakeyaml <rest_of_args>
349+
./run_macaron.sh --local-repos-path ./boo/foo --defaults-path ./defaults.ini analyze -rp target <rest_of_args>
350350
351351
With ``rest_of_args`` being the arguments to the ``analyze`` command (e.g. ``-b``, ``-d`` or ``--skip-deps`` similar to two previous examples).
352352

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>`.
354354

355355
.. 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``.
356356

@@ -376,7 +376,7 @@ We can run Macaron against the local repository at ``target`` by using this comm
376376
377377
With ``rest_of_args`` being the arguments to the ``analyze`` command (e.g. ``-b``, ``-d`` or ``--skip-deps`` similar to two previous examples).
378378

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>`.
380380

381381
.. 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``.
382382

0 commit comments

Comments
 (0)