Skip to content

Commit

Permalink
Merge pull request #6306 from kit-ty-kate/doc-repo-stamp
Browse files Browse the repository at this point in the history
Manual: Document the stamp field from repo files
  • Loading branch information
rjbou authored Nov 22, 2024
2 parents 3a11680 + 2fac58c commit 88318b9
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
7 changes: 7 additions & 0 deletions doc/pages/Manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -800,6 +800,13 @@ some specifics of the repository. It has the following optional fields:
* <a id="repofield-announce">`announce: [ <string> { <filter> } ... ]`</a>:
Messages that will be printed to the user on initialisation or update of this
repository, with optional conditions.
* <a id="repofield-stamp">`stamp: <string>`</a>:
A string referring to the commit hash or timestamp of the current state of
the repository. For example if the repository source originally comes from
a git repository but is distributed through a http endpoint, that http
server could distribute a `repo` file, whose `stamp` field could refer
to the commit hash linked to the current state of the repository delivered
in tar.gz format.

#### opamrc

Expand Down
1 change: 1 addition & 0 deletions master_changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ users)
* Unhide `OpamProcess` functions [#6150 @rjbou]
* Fix a typo in the default man page [#6267 @fccm2]
* Point users to ways to override the default opam root location in the opam init manpage [#6251 @kit-ty-kate]
* Manual: Document the stamp field from repo files [#6306 @kit-ty-kate]

## Security fixes

Expand Down

0 comments on commit 88318b9

Please sign in to comment.