diff --git a/docs/_images/user/blame/view.png b/docs/_images/user/blame/view.png new file mode 100644 index 00000000..e41d636e Binary files /dev/null and b/docs/_images/user/blame/view.png differ diff --git a/docs/user/blame.md b/docs/user/blame.md new file mode 100644 index 00000000..12b02ec1 --- /dev/null +++ b/docs/user/blame.md @@ -0,0 +1,27 @@ +--- +title: 'Blame File View' +license: 'Apache-2.0' +origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/blame.en-us.md' +--- + +Forgejo supports viewing the line-by-line revision history for a file also known as blame view. +You can also use [`git blame`](https://git-scm.com/docs/git-blame) on the command line to view the revision history of lines within a file. + +![Blame view of a file](../_images/user/blame/view.png) + +1. Navigate to and open the file whose line history you want to view. +1. Click the `Blame` button in the file header bar. +1. The new view shows the line-by-line revision history for a file with author and commit information on the left side. +1. To navigate to an older commit, click the icon. + +## Ignore commits in the blame view + +All revisions specified in the `.git-blame-ignore-revs` file are hidden from the blame view. +This is especially useful to hide reformatting changes and keep the benefits of `git blame`. +Lines that were changed or added by an ignored commit will be blamed on the previous commit that changed that line or nearby lines. +The `.git-blame-ignore-revs` file must be located in the root directory of the repository. +For more information like the file format, see [the `git blame --ignore-revs-file` documentation](https://git-scm.com/docs/git-blame#Documentation/git-blame.txt---ignore-revs-fileltfilegt). + +### Bypassing `.git-blame-ignore-revs` in the blame view + +If the blame view for a file shows a message about ignored revisions, you can see the normal blame view by appending the url parameter `?bypass-blame-ignore=true`. diff --git a/docs/user/index.md b/docs/user/index.md index 4fbbdd85..2dfb387d 100644 --- a/docs/user/index.md +++ b/docs/user/index.md @@ -27,6 +27,7 @@ involved in running it on their machines. - [Clone & Commit via Web](https://docs.codeberg.org/git/clone-commit-via-web/) - [Tags and Releases](https://docs.codeberg.org/git/using-tags/) - [Branch and tag protection](./protection/) + - [Git blame](./blame/) - Advanced Usage - [Issue and Pull Request Templates](./issue-pull-request-templates/) - [Actions](./actions/)