diff options
| author | Edward Thomson <ethomson@github.com> | 2017-01-21 23:45:23 +0000 |
|---|---|---|
| committer | Edward Thomson <ethomson@github.com> | 2017-01-21 23:45:23 +0000 |
| commit | 28d0ba0ba5f41f71997a15e81bbda4ed2d1b896a (patch) | |
| tree | b03c94a2b3a901f12503c10ff6fc13d130668c32 /include/git2 | |
| parent | 452bf57cbe665768810f2597aba50b9afc9509a7 (diff) | |
| download | libgit2-28d0ba0ba5f41f71997a15e81bbda4ed2d1b896a.tar.gz | |
symbolic ref target validation: fixups
Fixups requested in #3912.
Diffstat (limited to 'include/git2')
| -rw-r--r-- | include/git2/common.h | 18 |
1 files changed, 8 insertions, 10 deletions
diff --git a/include/git2/common.h b/include/git2/common.h index 02d263048..3304f46d2 100644 --- a/include/git2/common.h +++ b/include/git2/common.h @@ -157,7 +157,7 @@ typedef enum { GIT_OPT_SET_SSL_CERT_LOCATIONS, GIT_OPT_SET_USER_AGENT, GIT_OPT_ENABLE_STRICT_OBJECT_CREATION, - GIT_OPT_ENABLE_SYMBOLIC_REF_TARGET_VALIDATION, + GIT_OPT_ENABLE_STRICT_SYMBOLIC_REF_CREATION, GIT_OPT_SET_SSL_CIPHERS, GIT_OPT_GET_USER_AGENT, } git_libgit2_opt_t; @@ -272,16 +272,14 @@ typedef enum { * > will be validated when creating a new commit. This defaults * > to disabled. * - * * opts(GIT_OPT_ENABLE_SYMBOLIC_REF_TARGET_VALIDATION, int enabled) + * * opts(GIT_OPT_ENABLE_STRICT_SYMBOLIC_REF_CREATION, int enabled) * - * > Validate the target of a symbolic ref when creating it. - * > For example, 'foobar' is not a valid ref, - * > therefore 'foobar' is not a valid target - * > for a symbolic ref by default, - * > where as 'refs/heads/foobar' is. - * > Disabling this bypasses validation so that an arbitrary - * > strings such as 'foobar' can be used for a symbolic ref target. - * > This defaults to enabled. + * > Validate the target of a symbolic ref when creating it. For + * > example, `foobar` is not a valid ref, therefore `foobar` is + * > not a valid target for a symbolic ref by default, whereas + * > `refs/heads/foobar` is. Disabling this bypasses validation + * > so that an arbitrary strings such as `foobar` can be used + * > for a symbolic ref target. This defaults to enabled. * * * opts(GIT_OPT_SET_SSL_CIPHERS, const char *ciphers) * |