mirror of
https://github.com/git/git.git
synced 2025-12-05 18:47:16 -06:00
0d8f4ccfe3
Doc lint updates to encourage the newer and easier-to-use `synopsis` format, with fixes to a handful of existing uses. * ja/doc-lint-sections-and-synopsis: doc lint: check that synopsis manpages have synopsis inlines doc:git-for-each-ref: fix styling and typos doc: check for absence of the form --[no-]parameter doc: check for absence of multiple terms in each entry of desc list doc: check well-formedness of delimited sections doc: test linkgit macros for well-formedness
27 lines
1014 B
C
27 lines
1014 B
C
#ifndef FOR_EACH_REF_H
|
|
#define FOR_EACH_REF_H
|
|
|
|
struct repository;
|
|
|
|
/*
|
|
* Shared usage string for options common to git-for-each-ref(1)
|
|
* and git-refs-list(1). The command-specific part (e.g., "git refs list ")
|
|
* must be prepended by the caller.
|
|
*/
|
|
#define COMMON_USAGE_FOR_EACH_REF \
|
|
"[--count=<count>] [--shell|--perl|--python|--tcl]\n" \
|
|
" [(--sort=<key>)...] [--format=<format>]\n" \
|
|
" [--include-root-refs] [--points-at=<object>]\n" \
|
|
" [--merged[=<object>]] [--no-merged[=<object>]]\n" \
|
|
" [--contains[=<object>]] [--no-contains[=<object>]]\n" \
|
|
" [(--exclude=<pattern>)...] [--start-after=<marker>]\n" \
|
|
" [ --stdin | (<pattern>...)]"
|
|
|
|
/*
|
|
* The core logic for for-each-ref and its clones.
|
|
*/
|
|
int for_each_ref_core(int argc, const char **argv, const char *prefix,
|
|
struct repository *repo, const char *const *usage);
|
|
|
|
#endif /* FOR_EACH_REF_H */
|