From fe67e404da4230149ada1b94acadf7dde828b22e Mon Sep 17 00:00:00 2001 From: Russell Belfer Date: Tue, 9 Oct 2012 14:35:24 -0700 Subject: [PATCH] Move enum comments next to actual values --- include/git2/checkout.h | 44 +++++++++++---------- include/git2/diff.h | 87 ++++++++++++++++++++--------------------- 2 files changed, 66 insertions(+), 65 deletions(-) diff --git a/include/git2/checkout.h b/include/git2/checkout.h index fb1a23030..bc532bb58 100644 --- a/include/git2/checkout.h +++ b/include/git2/checkout.h @@ -26,32 +26,34 @@ GIT_BEGIN_DECL * * These flags control what checkout does with files. Pass in a * combination of these values OR'ed together. - * - * - GIT_CHECKOUT_DEFAULT: With this value, checkout does not update - * any files in the working directory. - * - GIT_CHECKOUT_OVERWRITE_MODIFIED: When a file exists and is modified, - * replace the modifications with the new version. - * - GIT_CHECKOUT_CREATE_MISSING: When a file does not exist in the - * working directory, create it. - * - GIT_CHECKOUT_REMOVE_UNTRACKED: If an untracked file in encountered - * in the working directory, delete it. */ typedef enum { - GIT_CHECKOUT_DEFAULT = (1 << 0), - GIT_CHECKOUT_OVERWRITE_MODIFIED = (1 << 1), - GIT_CHECKOUT_CREATE_MISSING = (1 << 2), - GIT_CHECKOUT_REMOVE_UNTRACKED = (1 << 3), + /** Checkout does not update any files in the working directory. */ + GIT_CHECKOUT_DEFAULT = (1 << 0), + + /** When a file exists and is modified, replace it with new version. */ + GIT_CHECKOUT_OVERWRITE_MODIFIED = (1 << 1), + + /** When a file does not exist in the working directory, create it. */ + GIT_CHECKOUT_CREATE_MISSING = (1 << 2), + + /** If an untracked file in found in the working dir, delete it. */ + GIT_CHECKOUT_REMOVE_UNTRACKED = (1 << 3), } git_checkout_strategy_t; -/* Use zeros to indicate default settings */ +/** + * Checkout options structure + * + * Use zeros to indicate default settings. + */ typedef struct git_checkout_opts { - unsigned int checkout_strategy; /* default: GIT_CHECKOUT_DEFAULT */ - int disable_filters; - int dir_mode; /* default is 0755 */ - int file_mode; /* default is 0644 */ - int file_open_flags; /* default is O_CREAT | O_TRUNC | O_WRONLY */ + unsigned int checkout_strategy; /** default: GIT_CHECKOUT_DEFAULT */ + int disable_filters; /** don't apply filters like CRLF conversion */ + int dir_mode; /** default is 0755 */ + int file_mode; /** default is 0644 or 0755 as dictated by blob */ + int file_open_flags; /** default is O_CREAT | O_TRUNC | O_WRONLY */ - /* Optional callback to notify the consumer of files that + /** Optional callback to notify the consumer of files that * haven't be checked out because a modified version of them * exist in the working directory. * @@ -66,7 +68,7 @@ typedef struct git_checkout_opts { void *notify_payload; - /* when not NULL, arrays of fnmatch pattern specifying + /** When not NULL, array of fnmatch patterns specifying * which paths should be taken into account */ git_strarray paths; diff --git a/include/git2/diff.h b/include/git2/diff.h index 1d32d9ad2..1932db029 100644 --- a/include/git2/diff.h +++ b/include/git2/diff.h @@ -32,53 +32,60 @@ GIT_BEGIN_DECL /** * Flags for diff options. A combination of these flags can be passed * in via the `flags` value in the `git_diff_options`. - * - * The flags are: - * - * - GIT_DIFF_NORMAL: normal diff, the default. - * - GIT_DIFF_REVERSE: reverse the sides of the diff. - * - GIT_DIFF_FORCE_TEXT: treat all as text, no binary attributes / detection. - * - GIT_DIFF_IGNORE_WHITESPACE: ignore all whitespace. - * - GIT_DIFF_IGNORE_WHITESPACE_CHANGE: ignore changes in amount of whitespace. - * - GIT_DIFF_IGNORE_WHITESPACE_EOL: ignore whitespace only at end-of-line. - * - GIT_DIFF_IGNORE_SUBMODULES: exclude submodules from diff completely. - * - GIT_DIFF_PATIENCE: use "patience diff" algorithm - * - GIT_DIFF_INCLUDE_IGNORED: include ignored files in the diff list - * - GIT_DIFF_INCLUDE_UNTRACKED: include untracked files in the diff list - * - GIT_DIFF_INCLUDE_UNMODIFIED: include unmodified files in the diff list - * - GIT_DIFF_RECURSE_UNTRACKED_DIRS: even with the INCLUDE_UNTRACKED flag, - * when am untracked directory is found, only a single entry for the directory - * will be included in the diff list; with this flag, all files under the - * directory will be included, too. - * - GIT_DIFF_DISABLE_PATHSPEC_MATCH: if the pathspec is set in the diff - * options, this flags means to interpret it exactly instead of fnmatch. - * - GIT_DIFF_DELTAS_ARE_ICASE: use case insensitive filename comparisons - * - GIT_DIFF_DONT_SPLIT_TYPECHANGE: normally, a type change between files - * will be converted into a DELETED record for the old file and an ADDED - * record for the new one; this option enabled TYPECHANGE records. - * - GIT_DIFF_SKIP_BINARY_CHECK: the binary flag in the delta record will - * not be updated. This is useful if iterating over a diff without hunk - * and line callbacks and you want to avoid loading files completely. */ enum { + /** Normal diff, the default */ GIT_DIFF_NORMAL = 0, + /** Reverse the sides of the diff */ GIT_DIFF_REVERSE = (1 << 0), + /** Treat all files as text, disabling binary attributes & detection */ GIT_DIFF_FORCE_TEXT = (1 << 1), + /** Ignore all whitespace */ GIT_DIFF_IGNORE_WHITESPACE = (1 << 2), + /** Ignore changes in amount of whitespace */ GIT_DIFF_IGNORE_WHITESPACE_CHANGE = (1 << 3), + /** Ignore whitespace at end of line */ GIT_DIFF_IGNORE_WHITESPACE_EOL = (1 << 4), + /** Exclude submodules from the diff completely */ GIT_DIFF_IGNORE_SUBMODULES = (1 << 5), + /** Use the "patience diff" algorithm (currently unimplemented) */ GIT_DIFF_PATIENCE = (1 << 6), + /** Include ignored files in the diff list */ GIT_DIFF_INCLUDE_IGNORED = (1 << 7), + /** Include untracked files in the diff list */ GIT_DIFF_INCLUDE_UNTRACKED = (1 << 8), + /** Include unmodified files in the diff list */ GIT_DIFF_INCLUDE_UNMODIFIED = (1 << 9), + /** Even with the GIT_DIFF_INCLUDE_UNTRACKED flag, when an untracked + * directory is found, only a single entry for the directory is added + * to the diff list; with this flag, all files under the directory will + * be included, too. + */ GIT_DIFF_RECURSE_UNTRACKED_DIRS = (1 << 10), + /** If the pathspec is set in the diff options, this flags means to + * apply it as an exact match instead of as an fnmatch pattern. + */ GIT_DIFF_DISABLE_PATHSPEC_MATCH = (1 << 11), + /** Use case insensitive filename comparisons */ GIT_DIFF_DELTAS_ARE_ICASE = (1 << 12), + /** When generating patch text, include the content of untracked files */ GIT_DIFF_INCLUDE_UNTRACKED_CONTENT = (1 << 13), + /** Disable updating of the `binary` flag in delta records. This is + * useful when iterating over a diff if you don't need hunk and data + * callbacks and want to avoid having to load file completely. + */ GIT_DIFF_SKIP_BINARY_CHECK = (1 << 14), + /** Normally, a type change between files will be converted into a + * DELETED record for the old and an ADDED record for the new; this + * options enabled the generation of TYPECHANGE delta records. + */ GIT_DIFF_INCLUDE_TYPECHANGE = (1 << 15), - GIT_DIFF_INCLUDE_TYPECHANGE_TREES = (1 << 16), + /** Even with GIT_DIFF_INCLUDE_TYPECHANGE, blob->tree changes still + * generally show as a DELETED blob. This flag tries to correctly + * label blob->tree transitions as TYPECHANGE records with new_file's + * mode set to tree. Note: the tree SHA will not be available. + */ + GIT_DIFF_INCLUDE_TYPECHANGE_TREES = (1 << 16), }; /** @@ -115,24 +122,16 @@ typedef struct git_diff_list git_diff_list; * Flags that can be set for the file on side of a diff. * * Most of the flags are just for internal consumption by libgit2, - * but some of them may be interesting to external users. They are: - * - * - VALID_OID - the `oid` value is computed and correct - * - FREE_PATH - the `path` string is separated allocated memory - * - BINARY - this file should be considered binary data - * - NOT_BINARY - this file should be considered text data - * - FREE_DATA - the internal file data is kept in allocated memory - * - UNMAP_DATA - the internal file data is kept in mmap'ed memory - * - NO_DATA - this side of the diff should not be loaded + * but some of them may be interesting to external users. */ enum { - GIT_DIFF_FILE_VALID_OID = (1 << 0), - GIT_DIFF_FILE_FREE_PATH = (1 << 1), - GIT_DIFF_FILE_BINARY = (1 << 2), - GIT_DIFF_FILE_NOT_BINARY = (1 << 3), - GIT_DIFF_FILE_FREE_DATA = (1 << 4), - GIT_DIFF_FILE_UNMAP_DATA = (1 << 5), - GIT_DIFF_FILE_NO_DATA = (1 << 6), + GIT_DIFF_FILE_VALID_OID = (1 << 0), /** `oid` value is known correct */ + GIT_DIFF_FILE_FREE_PATH = (1 << 1), /** `path` is allocated memory */ + GIT_DIFF_FILE_BINARY = (1 << 2), /** should be considered binary data */ + GIT_DIFF_FILE_NOT_BINARY = (1 << 3), /** should be considered text data */ + GIT_DIFF_FILE_FREE_DATA = (1 << 4), /** internal file data is allocated */ + GIT_DIFF_FILE_UNMAP_DATA = (1 << 5), /** internal file data is mmap'ed */ + GIT_DIFF_FILE_NO_DATA = (1 << 6), /** file data should not be loaded */ }; /**