Skip to content

Commit

Permalink
Merge pull request #268 from pv/repo-doc
Browse files Browse the repository at this point in the history
Document that 'repo' config value can also be a relative path
  • Loading branch information
mdboom committed May 4, 2015
2 parents ff13b58 + 6056fd7 commit 64d5469
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
6 changes: 6 additions & 0 deletions docs/source/asv.conf.json.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ results page back to your project.
--------
The URL to the repository for the project.

The value can also be a path, relative to the location of the
configuration file. For example, if the benchmarks are stored in the
same repository as the project itself, and the configuration file is
located at ``benchmarks/asv.conf.json`` inside the repository, you can
set ``"repo": ".."`` to use the local repository.

Currently, only ``git`` and ``hg`` repositories are supported, so this must be
a URL that ``git`` or ``hg`` know how to clone from, for example:

Expand Down
8 changes: 7 additions & 1 deletion docs/source/using.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,18 @@ suite are:

- ``project_url``: The project's homepage.

- ``repo``: The URL to the DVCS repository for the project. This
- ``repo``: The URL or path to the DVCS repository for the project. This
should be a read-only URL so that anyone, even those without commit
rights to the repository, can run the benchmarks. For a project on
github, for example, the URL would look like:
``https://github.com/spacetelescope/asv.git``

The value can also be a path, relative to the location of the
configuration file. For example, if the benchmarks are stored
in the same repository as the project itself, and the configuration
file is located at ``benchmarks/asv.conf.json`` inside the repository,
you can set ``"repo": ".."`` to use the local repository.

- ``show_commit_url``: The base of URLs used to display commits for
the project. This allows users to click on a commit in the web
interface and have it display the contents of that commit. For a
Expand Down

0 comments on commit 64d5469

Please sign in to comment.