Liking cljdoc? Tell your friends :D

swhid.git

SWHIDs from a local Git repository: rev / rel / snp, and the dir / cnt SWHIDs of its tracked working tree.

Shells out to the git binary to read refs, object types and the index; the hashing itself is done by swhid.hash.

The snapshot covers all refs of the repository (including remotes), plus HEAD and other symbolic refs as aliases, matching what swh identify (swh.model) computes for a local repository. One difference, by choice: a dangling symbolic ref other than HEAD (as refs/remotes/origin/HEAD after the remote's default branch was renamed and pruned) is left out, as git for-each-ref leaves it out; swh identify includes it as an alias.

SWHIDs from a local Git repository: rev / rel / snp, and the dir / cnt
SWHIDs of its tracked working tree.

Shells out to the `git` binary to read refs, object types and the
index; the hashing itself is done by swhid.hash.

The snapshot covers all refs of the repository (including remotes),
plus HEAD and other symbolic refs as aliases, matching what
`swh identify` (swh.model) computes for a local repository. One
difference, by choice: a dangling symbolic ref other than HEAD (as
refs/remotes/origin/HEAD after the remote's default branch was
renamed and pruned) is left out, as `git for-each-ref` leaves it
out; swh identify includes it as an alias.
raw docstring

blob-swhidclj

(blob-swhid repo-path path)

SWHID map of the file at path (relative) in the repository at repo-path, hashed as git add would store it: its clean filters and text conversion apply, so this is what the archive would hold.

SWHID map of the file at `path` (relative) in the repository at
`repo-path`, hashed as `git add` would store it: its clean filters and
text conversion apply, so this is what the archive would hold.
sourceraw docstring

release-swhidclj

(release-swhid repo-path tag)

SWHID map of a release (annotated tag) tag of the local Git repository at repo-path.

SWHID map of a release (annotated tag) `tag` of the local Git
repository at `repo-path`.
sourceraw docstring

revision-swhidclj

(revision-swhid repo-path)
(revision-swhid repo-path rev)

SWHID map of a revision of the local Git repository at repo-path. rev is anything git rev-parse accepts (defaults to "HEAD").

SWHID map of a revision of the local Git repository at `repo-path`.
`rev` is anything git rev-parse accepts (defaults to "HEAD").
sourceraw docstring

snapshot-swhidclj

(snapshot-swhid repo-path)

SWHID map of the snapshot of the local Git repository at repo-path.

SWHID map of the snapshot of the local Git repository at `repo-path`.
sourceraw docstring

worktree-swhidsclj

(worktree-swhids repo-path)

Map of relative path -> SWHID map for the tracked working tree of the Git repository at repo-path, the root under ".": every file in the index, no untracked or ignored file, and no ".git". Files modified in the working tree are hashed as git add would store them (clean filters, autocrlf, core.fileMode, core.symlinks), deleted ones are left out, a submodule counts with the HEAD of its checkout. Directory SWHIDs are those the archive computes from a commit of this tree; submodules are :revision entries, as in the archive.

Map of relative path -> SWHID map for the tracked working tree of the
Git repository at `repo-path`, the root under ".": every file in the
index, no untracked or ignored file, and no ".git". Files modified in
the working tree are hashed as `git add` would store them (clean
filters, autocrlf, core.fileMode, core.symlinks), deleted ones are
left out, a submodule counts with the HEAD of its checkout. Directory
SWHIDs are those the archive computes from a commit of this tree;
submodules are :revision entries, as in the archive.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close