diff options
context:
space:
mode:
authorBryce Kwon <bryce@brycekwon.com>
committerBryce Kwon <bryce@brycekwon.com>
commit
parent
tree
download
Tabulate the query parameters in the readme
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt46
1 file changed, 23 insertions, 23 deletions
diff --git a/README.txt b/README.txt
index 54dbcae..d0953a2 100644
--- a/README.txt
+++ b/README.txt
@@ -157,30 +157,30 @@ src/main.c. A repository whose name contains a character that is special in a
url has it percent-encoded, and a plus sign has to be written %2b because a bare
plus decodes to a space.
-These parameters are accepted, all of them optional.
+Every parameter is optional. The pages column names the pages that read each
+one, where a value of all marks the few not tied to particular pages.
- url repository, page and path in one value, used instead of
- the path form
- h the branch or ref to read, defaulting to the repository
- default
- id pin the page to one commit or object, which every page
- that shows history honours
- id2 the second object for a diff, so id and id2 name the
- two sides
- ofs offset into a paged listing, used by log, refs and stats
- path restrict the page to one path, equivalent to the
- trailing path
- q the search term
- qt what to search, one of grep, author, committer or range
- s sort key on the index and refs pages
- showmsg show full commit messages in a log listing
- period the statistics window, one of w, m, q or y
- dt diff type, selecting unified, side by side or raw
- ss shorthand for the side by side diff
- all include every ref rather than one branch, used by atom
- context lines of context in a diff
- ignorews ignore whitespace when diffing
- follow follow a single path across renames in a log
++----------+----------------------+---------------------------------------------+
+| param | pages | description |
++----------+----------------------+---------------------------------------------+
+| url | all | repository, page and path in one value |
+| h | all | the branch or ref to read |
+| id | all | pin the page to one commit or object |
+| id2 | diff patch rawdiff | the second object of a diff, paired with id |
+| ofs | index log refs stats | offset into a paged listing |
+| path | all | restrict the page to one path |
+| q | log | the search term |
+| qt | log | one of grep, author, committer or range |
+| s | index | sort key for the listing |
+| showmsg | log | show full commit messages |
+| period | stats | the statistics window, one of w, m, q or y |
+| dt | diff commit | diff type, unified, side by side or raw |
+| ss | diff commit | shorthand for the side by side diff |
+| all | atom | include every ref rather than one branch |
+| context | diff commit | lines of context around a diff hunk |
+| ignorews | diff commit | ignore whitespace when diffing |
+| follow | log | follow a single path across renames |
++----------+----------------------+---------------------------------------------+
A few endpoints are not ordinary pages. The snapshot page takes a filename
rather than a ref, so /demo/snapshot/demo-1.0.tar.gz names both the ref and the