Commit b4117e19 by Carlos Martín Nieto

docs: formatting fixes

parent 879458e7
...@@ -228,7 +228,7 @@ GIT_EXTERN(void) git_attr_cache_flush( ...@@ -228,7 +228,7 @@ GIT_EXTERN(void) git_attr_cache_flush(
* function allows you to add others. For example, to add the default * function allows you to add others. For example, to add the default
* macro, you would call: * macro, you would call:
* *
* git_attr_add_macro(repo, "binary", "-diff -crlf"); * git_attr_add_macro(repo, "binary", "-diff -crlf");
*/ */
GIT_EXTERN(int) git_attr_add_macro( GIT_EXTERN(int) git_attr_add_macro(
git_repository *repo, git_repository *repo,
......
...@@ -142,34 +142,42 @@ enum { ...@@ -142,34 +142,42 @@ enum {
* *
* Available options: * Available options:
* *
* opts(GIT_OPT_GET_MWINDOW_SIZE, size_t *): * * opts(GIT_OPT_GET_MWINDOW_SIZE, size_t *):
* Get the maximum mmap window size
* *
* opts(GIT_OPT_SET_MWINDOW_SIZE, size_t): * > Get the maximum mmap window size
* Set the maximum mmap window size
* *
* opts(GIT_OPT_GET_MWINDOW_MAPPED_LIMIT, size_t *): * * opts(GIT_OPT_SET_MWINDOW_SIZE, size_t):
* Get the maximum memory that will be mapped in total by the library
* *
* opts(GIT_OPT_SET_MWINDOW_MAPPED_LIMIT, size_t): * > Set the maximum mmap window size
* Set the maximum amount of memory that can be mapped at any time *
* * opts(GIT_OPT_GET_MWINDOW_MAPPED_LIMIT, size_t *):
*
* > Get the maximum memory that will be mapped in total by the library
*
* * opts(GIT_OPT_SET_MWINDOW_MAPPED_LIMIT, size_t):
*
* >Set the maximum amount of memory that can be mapped at any time
* by the library * by the library
* *
* opts(GIT_OPT_GET_SEARCH_PATH, int level, char *out, size_t len) * * opts(GIT_OPT_GET_SEARCH_PATH, int level, char *out, size_t len)
* Get the search path for a given level of config data. "level" must *
* be one of GIT_CONFIG_LEVEL_SYSTEM, GIT_CONFIG_LEVEL_GLOBAL, or * > Get the search path for a given level of config data. "level" must
* GIT_CONFIG_LEVEL_XDG. The search path is written to the `out` * > be one of `GIT_CONFIG_LEVEL_SYSTEM`, `GIT_CONFIG_LEVEL_GLOBAL`, or
* buffer up to size `len`. Returns GIT_EBUFS if buffer is too small. * > `GIT_CONFIG_LEVEL_XDG`. The search path is written to the `out`
* * > buffer up to size `len`. Returns GIT_EBUFS if buffer is too small.
* opts(GIT_OPT_SET_SEARCH_PATH, int level, const char *path) *
* Set the search path for a level of config data. The search path * * opts(GIT_OPT_SET_SEARCH_PATH, int level, const char *path)
* applied to shared attributes and ignore files, too. *
* - `path` lists directories delimited by GIT_PATH_LIST_SEPARATOR. * > Set the search path for a level of config data. The search path
* Pass NULL to reset to the default (generally based on environment * > applied to shared attributes and ignore files, too.
* variables). Use magic path `$PATH` to include the old value * >
* of the path (if you want to prepend or append, for instance). * > - `path` lists directories delimited by GIT_PATH_LIST_SEPARATOR.
* - `level` must be GIT_CONFIG_LEVEL_SYSTEM, GIT_CONFIG_LEVEL_GLOBAL, * > Pass NULL to reset to the default (generally based on environment
* or GIT_CONFIG_LEVEL_XDG. * > variables). Use magic path `$PATH` to include the old value
* > of the path (if you want to prepend or append, for instance).
* >
* > - `level` must be GIT_CONFIG_LEVEL_SYSTEM, GIT_CONFIG_LEVEL_GLOBAL,
* > or GIT_CONFIG_LEVEL_XDG.
* *
* @param option Option key * @param option Option key
* @param ... value to set the option * @param ... value to set the option
......
...@@ -30,11 +30,11 @@ typedef struct git_cred_userpass_payload { ...@@ -30,11 +30,11 @@ typedef struct git_cred_userpass_payload {
/** /**
* Stock callback usable as a git_cred_acquire_cb. This calls * Stock callback usable as a git_cred_acquire_cb. This calls
* git_cred_userpass_plaintext_new unless the protocol has not specified * git_cred_userpass_plaintext_new unless the protocol has not specified
* GIT_CREDTYPE_USERPASS_PLAINTEXT as an allowed type. * `GIT_CREDTYPE_USERPASS_PLAINTEXT` as an allowed type.
* *
* @param cred The newly created credential object. * @param cred The newly created credential object.
* @param url The resource for which we are demanding a credential. * @param url The resource for which we are demanding a credential.
* @param username_from_url The username that was embedded in a "user@host" * @param user_from_url The username that was embedded in a "user@host"
* remote url, or NULL if not included. * remote url, or NULL if not included.
* @param allowed_types A bitmask stating which cred types are OK to return. * @param allowed_types A bitmask stating which cred types are OK to return.
* @param payload The payload provided when specifying this callback. (This is * @param payload The payload provided when specifying this callback. (This is
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment