mirror of
https://github.com/git/git
synced 2024-08-24 10:15:51 +00:00
![Jameson Miller](/assets/img/avatar_default.png)
Teach the status command more flexibility in how ignored files are reported. Currently, the reporting of ignored files and untracked files are linked. You cannot control how ignored files are reported independently of how untracked files are reported (i.e. `all` vs `normal`). This makes it impossible to show untracked files with the `all` option, but show ignored files with the `normal` option. This work 1) adds the ability to control the reporting of ignored files independently of untracked files and 2) introduces the concept of status reporting ignored paths that explicitly match an ignored pattern. There are 2 benefits to these changes: 1) if a consumer needs all untracked files but not all ignored files, there is a performance benefit to not scanning all contents of an ignored directory and 2) returning ignored files that explicitly match a path allow a consumer to make more informed decisions about when a status result might be stale. This commit implements --ignored=matching with --untracked-files=all. The following commit will implement --ignored=matching with --untracked=files=normal. As an example of where this flexibility could be useful is that our application (Visual Studio) runs the status command and presents the output. It shows all untracked files individually (e.g. using the '--untracked-files==all' option), and would like to know about which paths are ignored. It uses information about ignored paths to make decisions about when the status result might have changed. Additionally, many projects place build output into directories inside a repository's working directory (e.g. in "bin/" and "obj/" directories). Normal usage is to explicitly ignore these 2 directory names in the .gitignore file (rather than or in addition to the *.obj pattern).If an application could know that these directories are explicitly ignored, it could infer that all contents are ignored as well and make better informed decisions about files in these directories. It could infer that any changes under these paths would not affect the output of status. Additionally, there can be a significant performance benefit by avoiding scanning through ignored directories. When status is set to report matching ignored files, it has the following behavior. Ignored files and directories that explicitly match an exclude pattern are reported. If an ignored directory matches an exclude pattern, then the path of the directory is returned. If a directory does not match an exclude pattern, but all of its contents are ignored, then the contained files are reported instead of the directory. Signed-off-by: Jameson Miller <jamill@microsoft.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
146 lines
3.6 KiB
C
146 lines
3.6 KiB
C
#ifndef STATUS_H
|
|
#define STATUS_H
|
|
|
|
#include <stdio.h>
|
|
#include "string-list.h"
|
|
#include "color.h"
|
|
#include "pathspec.h"
|
|
|
|
struct worktree;
|
|
|
|
enum color_wt_status {
|
|
WT_STATUS_HEADER = 0,
|
|
WT_STATUS_UPDATED,
|
|
WT_STATUS_CHANGED,
|
|
WT_STATUS_UNTRACKED,
|
|
WT_STATUS_NOBRANCH,
|
|
WT_STATUS_UNMERGED,
|
|
WT_STATUS_LOCAL_BRANCH,
|
|
WT_STATUS_REMOTE_BRANCH,
|
|
WT_STATUS_ONBRANCH,
|
|
WT_STATUS_MAXSLOT
|
|
};
|
|
|
|
enum untracked_status_type {
|
|
SHOW_NO_UNTRACKED_FILES,
|
|
SHOW_NORMAL_UNTRACKED_FILES,
|
|
SHOW_ALL_UNTRACKED_FILES
|
|
};
|
|
|
|
enum show_ignored_type {
|
|
SHOW_NO_IGNORED,
|
|
SHOW_TRADITIONAL_IGNORED,
|
|
SHOW_MATCHING_IGNORED,
|
|
};
|
|
|
|
/* from where does this commit originate */
|
|
enum commit_whence {
|
|
FROM_COMMIT, /* normal */
|
|
FROM_MERGE, /* commit came from merge */
|
|
FROM_CHERRY_PICK /* commit came from cherry-pick */
|
|
};
|
|
|
|
struct wt_status_change_data {
|
|
int worktree_status;
|
|
int index_status;
|
|
int stagemask;
|
|
int score;
|
|
int mode_head, mode_index, mode_worktree;
|
|
struct object_id oid_head, oid_index;
|
|
char *head_path;
|
|
unsigned dirty_submodule : 2;
|
|
unsigned new_submodule_commits : 1;
|
|
};
|
|
|
|
enum wt_status_format {
|
|
STATUS_FORMAT_NONE = 0,
|
|
STATUS_FORMAT_LONG,
|
|
STATUS_FORMAT_SHORT,
|
|
STATUS_FORMAT_PORCELAIN,
|
|
STATUS_FORMAT_PORCELAIN_V2,
|
|
|
|
STATUS_FORMAT_UNSPECIFIED
|
|
};
|
|
|
|
struct wt_status {
|
|
int is_initial;
|
|
char *branch;
|
|
const char *reference;
|
|
struct pathspec pathspec;
|
|
int verbose;
|
|
int amend;
|
|
enum commit_whence whence;
|
|
int nowarn;
|
|
int use_color;
|
|
int no_gettext;
|
|
int display_comment_prefix;
|
|
int relative_paths;
|
|
int submodule_summary;
|
|
enum show_ignored_type show_ignored_mode;
|
|
enum untracked_status_type show_untracked_files;
|
|
const char *ignore_submodule_arg;
|
|
char color_palette[WT_STATUS_MAXSLOT][COLOR_MAXLEN];
|
|
unsigned colopts;
|
|
int null_termination;
|
|
int commit_template;
|
|
int show_branch;
|
|
int show_stash;
|
|
int hints;
|
|
|
|
enum wt_status_format status_format;
|
|
unsigned char sha1_commit[GIT_MAX_RAWSZ]; /* when not Initial */
|
|
|
|
/* These are computed during processing of the individual sections */
|
|
int commitable;
|
|
int workdir_dirty;
|
|
const char *index_file;
|
|
FILE *fp;
|
|
const char *prefix;
|
|
struct string_list change;
|
|
struct string_list untracked;
|
|
struct string_list ignored;
|
|
uint32_t untracked_in_ms;
|
|
};
|
|
|
|
struct wt_status_state {
|
|
int merge_in_progress;
|
|
int am_in_progress;
|
|
int am_empty_patch;
|
|
int rebase_in_progress;
|
|
int rebase_interactive_in_progress;
|
|
int cherry_pick_in_progress;
|
|
int bisect_in_progress;
|
|
int revert_in_progress;
|
|
int detached_at;
|
|
char *branch;
|
|
char *onto;
|
|
char *detached_from;
|
|
unsigned char detached_sha1[20];
|
|
unsigned char revert_head_sha1[20];
|
|
unsigned char cherry_pick_head_sha1[20];
|
|
};
|
|
|
|
size_t wt_status_locate_end(const char *s, size_t len);
|
|
void wt_status_add_cut_line(FILE *fp);
|
|
void wt_status_prepare(struct wt_status *s);
|
|
void wt_status_print(struct wt_status *s);
|
|
void wt_status_collect(struct wt_status *s);
|
|
void wt_status_get_state(struct wt_status_state *state, int get_detached_from);
|
|
int wt_status_check_rebase(const struct worktree *wt,
|
|
struct wt_status_state *state);
|
|
int wt_status_check_bisect(const struct worktree *wt,
|
|
struct wt_status_state *state);
|
|
|
|
__attribute__((format (printf, 3, 4)))
|
|
void status_printf_ln(struct wt_status *s, const char *color, const char *fmt, ...);
|
|
__attribute__((format (printf, 3, 4)))
|
|
void status_printf(struct wt_status *s, const char *color, const char *fmt, ...);
|
|
|
|
/* The following functions expect that the caller took care of reading the index. */
|
|
int has_unstaged_changes(int ignore_submodules);
|
|
int has_uncommitted_changes(int ignore_submodules);
|
|
int require_clean_work_tree(const char *action, const char *hint,
|
|
int ignore_submodules, int gently);
|
|
|
|
#endif /* STATUS_H */
|