thodg/libgit2/include/git2/ignore.h

• Show log

  Commit

• Hash : 52032ae5
  Author :
  Date : 2012-10-15T12:48:43
  

  Fix single-file ignore checks
  
  To answer if a single given file should be ignored, the path to
  that file has to be processed progressively checking that there
  are no intermediate ignored directories in getting to the file
  in question.  This enables that, fixing the broken old behavior,
  and adds tests to exercise various ignore situations.
  

Download

• include/git2/ignore.h

• /*
   * Copyright (C) 2012 the libgit2 contributors
   *
   * This file is part of libgit2, distributed under the GNU GPL v2 with
   * a Linking Exception. For full terms see the included COPYING file.
   */
  #ifndef INCLUDE_git_ignore_h__
  #define INCLUDE_git_ignore_h__
  
  #include "common.h"
  #include "types.h"
  
  GIT_BEGIN_DECL
  
  /**
   * Add ignore rules for a repository.
   *
   * Excludesfile rules (i.e. .gitignore rules) are generally read from
   * .gitignore files in the repository tree or from a shared system file
   * only if a "core.excludesfile" config value is set.  The library also
   * keeps a set of per-repository internal ignores that can be configured
   * in-memory and will not persist.  This function allows you to add to
   * that internal rules list.
   *
   * Example usage:
   *
   *     error = git_ignore_add(myrepo, "*.c\ndir/\nFile with space\n");
   *
   * This would add three rules to the ignores.
   *
   * @param repo The repository to add ignore rules to.
   * @param rules Text of rules, a la the contents of a .gitignore file.
   *              It is okay to have multiple rules in the text; if so,
   *              each rule should be terminated with a newline.
   * @return 0 on success
   */
  GIT_EXTERN(int) git_ignore_add_rule(
  	git_repository *repo,
  	const char *rules);
  
  /**
   * Clear ignore rules that were explicitly added.
   *
   * Clears the internal ignore rules that have been set up.  This will not
   * turn off the rules in .gitignore files that actually exist in the
   * filesystem.
   *
   * @param repo The repository to remove ignore rules from.
   * @return 0 on success
   */
  GIT_EXTERN(int) git_ignore_clear_internal_rules(
  	git_repository *repo);
  
  /**
   * Test if the ignore rules apply to a given path.
   *
   * This function checks the ignore rules to see if they would apply to the
   * given file.  This indicates if the file would be ignored regardless of
   * whether the file is already in the index or commited to the repository.
   *
   * One way to think of this is if you were to do "git add ." on the
   * directory containing the file, would it be added or not?
   *
   * @param ignored boolean returning 0 if the file is not ignored, 1 if it is
   * @param repo a repository object
   * @param path the file to check ignores for, relative to the repo's workdir.
   * @return 0 if ignore rules could be processed for the file (regardless
   *         of whether it exists or not), or an error < 0 if they could not.
   */
  GIT_EXTERN(int) git_ignore_path_is_ignored(
  	int *ignored,
  	git_repository *repo,
  	const char *path);
  
  GIT_END_DECL
  
  #endif
  

Download