【问题标题】:How do I ignore files in a directory in Git?如何忽略 Git 目录中的文件?
【发布时间】:2012-01-21 14:12:33
【问题描述】:

.gitignore 文件忽略目录中文件的正确语法是什么?

会不会

config/databases.yml
cache/*
log/*
data/sql/*
lib/filter/base/*
lib/form/base/*
lib/model/map/*
lib/model/om/*

/config/databases.yml
/cache/*
/log/*
/data/sql/*
/lib/filter/base/*
/lib/form/base/*
/lib/model/map/*
/lib/model/om/*

?

【问题讨论】:

  • .gitignore 是否区分它忽略的文件和目录?例如,datadata/ 是否意味着不同的东西?
  • @CharlieParker yes-ish: data 将忽略文件匹配的目录,data/ 将只忽略匹配的目录。
  • 永远记住,如果你已经暂存或提交了你试图忽略的文件,那么就没有办法忽略它:(在我认为我的模式错误并浪费了四分之一之后,我只有 2 美分一个小时。
  • @Adam 正确,您必须更新 .gitignore 然后 unstage/git rm --cached 文件。

标签: git gitignore


【解决方案1】:

问题中的两个例子实际上都是非常糟糕的例子,可能导致数据丢失!

我的建议:切勿将 /* 附加到 .gitignore 文件中的目录,除非你有充分的理由!

例如 Jefromi 写的一个很好的理由是:“如果您打算随后取消忽略目录中的某些内容”

不应该这样做的原因是,一方面将/* 附加到目录确实会以正确忽略目录的所有内容的方式工作,但另一方面它也有危险的一面效果:

如果您在存储库中执行git stash -u(临时存储已跟踪和未跟踪的文件)或git clean -df(删除未跟踪但保留忽略的文件),所有被忽略并附加/* 的目录将是不可撤销地删除

一些背景

我必须以艰苦的方式学习这一点。我团队中的某个人将/* 附加到我们的.gitignore 中的某些目录中。随着时间的推移,我遇到过某些目录会突然消失的情况。包含我们应用程序所需的千兆字节本地数据的目录。没有人能解释它,我总是讨厌重新下载所有数据。过了一会儿,我想到它可能与git stash 有关。有一天,我想清理我的本地存储库(同时保留被忽略的文件),我正在使用git clean -df,但我的数据又消失了。这次我受够了并调查了这个问题。我终于想通了,原因是附加的/*

我认为这可以通过directory/* 确实忽略目录的所有内容而不是目录本身这一事实来解释。因此,当内容被删除时,它既不会被视为跟踪也不会被忽略。尽管git statusgit status --ignored 给出的图片略有不同。

如何重现

这里是如何重现该行为。我目前使用的是 Git 2.8.4。

将在本地 git 存储库中创建一个名为 localdata/ 的目录,其中包含一个虚拟文件 (important.dat),并将 /localdata/* 放入 .gitignore 文件中将忽略其内容。当现在执行上面提到的两个 git 命令之一时,该目录将(意外地)丢失。

mkdir test
cd test
git init
echo "/localdata/*" >.gitignore
git add .gitignore
git commit -m "Add .gitignore."
mkdir localdata
echo "Important data" >localdata/important.dat
touch untracked-file

如果您在此处输入git status --ignored,您将获得:

On branch master
Untracked files:
  (use "git add <file>..." to include in what will be committed)

  untracked-file

Ignored files:
  (use "git add -f <file>..." to include in what will be committed)

  localdata/

现在要么做

git stash -u
git stash pop

git clean -df

在这两种情况下,据称被忽略的目录localdata 都会消失!

不确定这是否可以被认为是一个错误,但我想这至少是一个没人需要的功能。

我会把这个报告给 git 开发列表,看看他们是怎么想的。

【讨论】:

    【解决方案2】:

    Android Studio 项目的示例 .gitignore 文件可能如下所示

    # built application files
    *.apk
    *.ap_
    
    # files for the dex VM
    *.dex
    
    # Java class files
    *.class
    
    # generated files
    bin/
    gen/
    
    # Local configuration file (sdk path, etc)
    local.properties
    
    
    #Eclipse
    *.pydevproject
    .project
    .metadata
    bin/**
    tmp/**
    tmp/**/*
    *.tmp
    *.bak
    *.swp
    *~.nib
    local.properties
    .classpath
    .settings/
    .loadpath
    YourProjetcName/.gradle/
    YourProjetcName/app/build/
    */YourProjetcName/.gradle/
    */YourProjetcName/app/build/
    
    # External tool builders
    .externalToolBuilders/
    
    # Locally stored "Eclipse launch configurations"
    *.launch
    
    # CDT-specific
    .cproject
    
    # PDT-specific
    .buildpath
    
    # Proguard folder generated by Eclipse
    proguard/
    
    # Intellij project files
    *.iml
    *.ipr
    *.iws
    .idea/
    /build
    build/
    */build/
    */*/build/
    */*/*/build/
    *.bin
    *.lock
    YourProjetcName/app/build/
    .gradle
    /local.properties
    /.idea/workspace.xml
    /.idea/libraries
    .DS_Store
    .gradle/
    app/build/
    *app/build/
    
    # Local configuration file (sdk path, etc)
    local.properties
    /YourProjetcName/build/intermediates/lint-cache/api-versions-6-23.1.bin
    appcompat_v7_23_1_1.xml
    projectFilesBackup
    build.gradle
    YourProjetcName.iml
    YourProjetcName.iml
    gradlew
    gradlew.bat
    local.properties
    settings.gradle
    .gradle
    .idea
    android
    build
    gradle
    

    【讨论】:

      【解决方案3】:

      图案格式

      • 空行不匹配任何文件,因此它可以用作分隔符以提高可读性。

      • # 开头的行用作注释。

      • 一个可选前缀! 否定模式;任何被先前模式排除的匹配文件都将再次包含在内。如果否定模式匹配,这将覆盖较低优先级的模式源。

      • 如果模式以斜线结尾,则出于以下描述的目的将其删除,但它只会找到与目录的匹配项。换句话说,foo/ 将匹配目录foo 及其下的路径,但不会匹配常规文件或符号链接foo(这与pathspec 在git 中的一般工作方式一致)。

      • 如果模式不包含斜线 /,git 将其视为 shell glob 模式并检查与 .gitignore 文件位置(相对于顶层工作树(如果不是来自 .gitignore 文件)。

      • 否则,git 将模式视为适合 fnmatch(3) 使用并带有 FNM_PATHNAME 标志的 shell glob:模式中的通配符将不匹配路径名中的 /。例如,Documentation/*.html 匹配 Documentation/git.html,但不匹配 Documentation/ppc/ppc.htmltools/perf/Documentation/perf.html

      • 前导斜杠匹配路径名的开头。例如,/*.c 匹配 cat-file.c 但不匹配 mozilla-sha1/sha1.c

      你可以在这里找到更多

      git help gitignore

      man gitignore

      【讨论】:

      • 如何将 .gitignore 文件放在顶层并使其适用于其下的任何文件夹?谢谢。
      • -1 TL;DR,几乎没有回答这个问题。它是关于目录的,而不是文件,所以加粗的部分只适合一些心理体操。 @Jefromi 更直接。
      • 我读过这个人,@ Jefromi 的答案更好——只要你也读过@jox 的警告——而@Luke Hutton 的可能更有助于忽略例如IDE 项目文件。
      • 这实际上是来自 git 文档的复制粘贴
      • 不确定(基本上)复制粘贴 man 页面或官方文档是 SO 的最佳格式...
      【解决方案4】:

      应该是前者。也可以使用扩展名而不是文件夹结构。

      即我的示例 C# 开发忽略文件:

      #OS junk files
      [Tt]humbs.db
      *.DS_Store
      
      #Visual Studio files
      *.[Oo]bj
      *.user
      *.aps
      *.pch
      *.vspscc
      *.vssscc
      *_i.c
      *_p.c
      *.ncb
      *.suo
      *.tlb
      *.tlh
      *.bak
      *.[Cc]ache
      *.ilk
      *.log
      *.lib
      *.sbr
      *.sdf
      ipch/
      obj/
      [Bb]in
      [Dd]ebug*/
      [Rr]elease*/
      Ankh.NoLoad
      
      #Tooling
      _ReSharper*/
      *.resharper
      [Tt]est[Rr]esult*
      
      #Project files
      [Bb]uild/
      
      #Subversion files
      .svn
      
      # Office Temp Files
      ~$*
      

      更新

      我想我会从下面的 cmets 提供更新。虽然没有直接回答 OP 的问题,但请参阅下面的 .gitignore 语法的更多示例。

      社区维基(不断更新):

      .gitignore for Visual Studio Projects and Solutions

      可以在此处找到更多使用特定语言的示例(感谢 Chris McKnight 的评论):

      https://github.com/github/gitignore

      【讨论】:

      • @Stallman,这是range。所以它匹配*.Obj 以及*.obj
      【解决方案5】:

      我正在维护一个基于 GUI 和 CLI 的服务,它允许您在 https://www.gitignore.io 上非常轻松地生成 .gitignore 模板。

      您可以在搜索字段中键入您想要的模板或安装命令行别名并运行

      $ gi swift,osx

      【讨论】:

        【解决方案6】:

        如果您想将 .gitignore 文件放在顶层并使其适用于其下的任何文件夹,请使用 /**/

        例如要忽略 /src/main/ 文件夹和子文件夹中的所有 *.map 文件,请使用:

        /src/main/**/*.map
        

        【讨论】:

        • 我需要这样做。不知道为什么你需要 两个 **'s。一个对我来说就足够了。
        • ** 也匹配子目录中的文件
        • 感谢@petrsyn 提供的信息
        【解决方案7】:

        前导斜杠表示忽略条目仅对 .gitignore 文件所在的目录有效。指定*.o 将忽略此目录和所有子目录中的所有.o 文件,而/*.o 将忽略该目录中的它们,而/foo/*.o 将仅忽略/foo/*.o 中的它们。

        【讨论】:

          【解决方案8】:

          包含斜杠的路径被视为相对于包含 .gitignore 文件的目录 - 通常是存储库的顶层,但您也可以将它们放在子目录中。

          因此,由于在您提供的所有示例中,路径都包含斜杠,因此两个版本是相同的。唯一需要放置前导斜杠的情况是路径中已经有没有。例如,要仅在存储库的顶层忽略 foo,请使用 /foo。简单地写foo 会忽略存储库中任何地方称为 foo 的任何内容。

          您的通配符也是多余的。如果你想忽略整个目录,只需命名它:

          lib/model/om
          

          以您的方式使用通配符的唯一原因是,如果您打算随后取消忽略目录中的某些内容:

          lib/model/om/*      # ignore everything in the directory
          !lib/model/om/foo   # except foo
          

          【讨论】:

          • 对这个问题的解释比接受的答案更好
          【解决方案9】:

          应该是:

          config/databases.yml
          cache
          log
          data/sql
          lib/filter/base
          lib/form/base
          lib/model/map
          lib/model/om
          

          甚至可能:

          config/databases.yml
          cache
          log
          data/sql
          lib/*/base
          lib/model/map
          lib/model/om
          

          如果 filterform 是 lib 中唯一具有需要忽略的 base子目录的目录(将其视为可以使用星号的示例)。

          【讨论】:

            【解决方案10】:

            第一个。这些文件路径相对于您的 .gitignore 文件所在的位置。

            【讨论】:

            • 这仅适用于包含斜线的模式。像“mydir”这样的单个目录名称也将忽略位于任何深度的子文件夹中的目录(和文件)。只有在前面加上一个斜线才能使它与 .gitignore 文件所在的位置相对。
            猜你喜欢
            • 1970-01-01
            • 2011-02-02
            • 1970-01-01
            • 1970-01-01
            • 2022-10-03
            • 2010-11-08
            • 2017-09-19
            • 1970-01-01
            • 1970-01-01
            相关资源
            最近更新 更多