jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Merge pull request #41793 from github/repo-sync

Browse Source 
Repo sync
This commit is contained in:
docs-bot
2023-08-31 15:57:36 -05:00
committed by GitHub
parent 066d64ecb0 e77f16ab2c
commit 062e7ebf2e
1 changed files with 10 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
content/get-started/getting-started-with-git/ignoring-files.md
View File

@@ -16,14 +16,14 @@ versions:
--- ---
## Configuring ignored files for a single repository ## Configuring ignored files for a single repository
You can create a _.gitignore_ file in your repository's root directory to tell Git which files and directories to ignore when you make a commit. You can create a `.gitignore` file in your repository's root directory to tell Git which files and directories to ignore when you make a commit.
To share the ignore rules with other users who clone the repository, commit the _.gitignore_ file in to your repository. To share the ignore rules with other users who clone the repository, commit the `.gitignore` file in to your repository.
GitHub maintains an official list of recommended _.gitignore_ files for many popular operating systems, environments, and languages in the `github/gitignore` public repository. You can also use gitignore.io to create a _.gitignore_ file for your operating system, programming language, or IDE. For more information, see "[github/gitignore](https://github.com/github/gitignore)" and the "[gitignore.io](https://www.gitignore.io/)" site. GitHub maintains an official list of recommended `.gitignore` files for many popular operating systems, environments, and languages in the "github/gitignore" public repository. You can also use gitignore.io to create a `.gitignore` file for your operating system, programming language, or IDE. For more information, see "[github/gitignore](https://github.com/github/gitignore)" and the "[gitignore.io](https://www.gitignore.io/)" site.
{% data reusables.command_line.open_the_multi_os_terminal %} {% data reusables.command_line.open_the_multi_os_terminal %}
1. Navigate to the location of your Git repository. 1. Navigate to the location of your Git repository.
1. Create a _.gitignore_ file for your repository. 1. Create a `.gitignore` file for your repository.
```shell ```shell
touch .gitignore touch .gitignore
@@ -31,7 +31,7 @@ GitHub maintains an official list of recommended _.gitignore_ files for many pop
If the command succeeds, there will be no output. If the command succeeds, there will be no output.
For an example _.gitignore_ file, see "[Some common .gitignore configurations](https://gist.github.com/octocat/9257657)" in the Octocat repository. For an example `.gitignore` file, see "[Some common .gitignore configurations](https://gist.github.com/octocat/9257657)" in the Octocat repository.
If you want to ignore a file that is already checked in, you must untrack the file before you add a rule to ignore it. From your terminal, untrack the file. If you want to ignore a file that is already checked in, you must untrack the file before you add a rule to ignore it. From your terminal, untrack the file.
@@ -41,25 +41,19 @@ git rm --cached FILENAME
## Configuring ignored files for all repositories on your computer ## Configuring ignored files for all repositories on your computer
You can also create a global _.gitignore_ file to define a list of rules for ignoring files in every Git repository on your computer. For example, you might create the file at _~/.gitignore_global_ and add some rules to it. You can tell Git to always ignore certain files or directories when you make a commit in any Git repository on your computer. For example, you could use this feature to ignore any temporary backup files that your text editor creates.
{% data reusables.command_line.open_the_multi_os_terminal %} To always ignore a certain file or directory, add it to a file named `ignore` that's located inside the directory `~/.config/git`. By default, Git will ignore any files and directories that are listed in the global configuration file `~/.config/git/ignore`. If the `git` directory and `ignore` file don't exist yet, you may need to create them.
1. Configure Git to use the exclude file _~/.gitignore_global_ for all Git repositories.
```shell
git config --global core.excludesfile ~/.gitignore_global
```
## Excluding local files without creating a _.gitignore_ file ## Excluding local files without creating a _.gitignore_ file
If you don't want to create a _.gitignore_ file to share with others, you can create rules that are not committed with the repository. You can use this technique for locally-generated files that you don't expect other users to generate, such as files created by your editor. If you don't want to create a `.gitignore` file to share with others, you can create rules that are not committed with the repository. You can use this technique for locally-generated files that you don't expect other users to generate, such as files created by your editor.
Use your favorite text editor to open the file called _.git/info/exclude_ within the root of your Git repository. Any rule you add here will not be checked in, and will only ignore files for your local repository. Use your favorite text editor to open the file called `.git/info/exclude` within the root of your Git repository. Any rule you add here will not be checked in, and will only ignore files for your local repository.
{% data reusables.command_line.open_the_multi_os_terminal %} {% data reusables.command_line.open_the_multi_os_terminal %}
1. Navigate to the location of your Git repository. 1. Navigate to the location of your Git repository.
1. Using your favorite text editor, open the file _.git/info/exclude_. 1. Using your favorite text editor, open the file `.git/info/exclude`.
## Further Reading ## Further Reading