~ivilata/gwit-spec

28b35939f9423cbef2966cf7268e2564f261e485 — Ivan Vilata-i-Balaguer 25 days ago bd4e88f
Clarify note on percent-encoded Git tag or branch names in URIs.
1 files changed, 1 insertions(+), 1 deletions(-)

M README.md
M README.md => README.md +1 -1
@@ 253,7 253,7 @@ with parts in square brackets being optional, and where

  Otherwise, `<VERSION>` may be the object name (hash) of a Git commit in the site's history, encoded as a string of hexadecimal digits (case-insensitive), in which case the URI refers to that commit. The name may be shortened by removing characters from its end, but this may cause content retrieval to fail if the client's Git clone of the site contains several commits with that same shortened name.

  `<VERSION>` may also be the name of a Git tag or branch in the client's Git clone of the site, percent-encoded if it contains reserved characters (as per Sections 2.1 and 2.2 of RFC3986). In that case the URI refers to the commit pointed by the tag or the branch head in the client's clone of the site. For security reasons (see further below), such tag or branch names MUST NOT consist only of hexadecimal digits (lower or upper case).
  `<VERSION>` may also be the name of a Git tag or branch in the client's Git clone of the site (percent-encoded if it contains reserved characters as per Sections 2.1 and 2.2 of RFC3986). In that case the URI refers to the commit pointed by the tag or the branch head in the client's clone of the site. For security reasons (see further below), such tag or branch names MUST NOT consist only of hexadecimal digits (lower or upper case).

  A tag signed by the site key may be used to succinctly convey a relevant point in the history of a site (like a release name). In contrast, branches and unsigned tags cannot be authenticated and their names may vary between clients, thus URIs using them SHOULD NOT be published in the general case, though gwit clients MAY support them as they can be useful for local debugging or internal site authoring.
- `<PATH>` is the absolute path of a file or directory in the site version referenced by the previous parts of the URI. The root of the path is the site's root directory (as per site configuration) in the Git commit corresponding to the desired site version, so the path maps to a Git blob object or tree object reachable from it.