From 0e8893e1ba6f39516feaf42e57a4ab3e33d8f41a Mon Sep 17 00:00:00 2001 From: Managor <42655600+Managor@users.noreply.github.com> Date: Mon, 5 May 2025 09:12:13 +0300 Subject: [PATCH] git*: refresh pages (#16372) Co-authored-by: Juri Dispan Co-authored-by: CleanMachine1 <78213164+CleanMachine1@users.noreply.github.com> Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> --- pages/common/git-authors.md | 4 ++-- pages/common/git-changelog.md | 12 ++++++------ pages/common/git-check-attr.md | 4 ++-- pages/common/git-check-ignore.md | 2 +- pages/common/git-cherry-pick.md | 2 +- pages/common/git-cola.md | 4 ++-- pages/common/git-commit-tree.md | 2 +- pages/common/git-config.md | 6 +++--- pages/common/git-count-objects.md | 6 +++--- pages/common/git-extras.md | 6 +++--- pages/common/git-feature.md | 4 ++-- pages/common/git-for-each-repo.md | 4 ++-- pages/common/git-format-patch.md | 4 ++-- pages/common/git-guilt.md | 4 ++-- pages/common/git-info.md | 2 +- pages/common/git-instaweb.md | 8 ++++---- pages/common/git-lfs.md | 2 +- pages/common/git-ls-files.md | 8 ++++---- pages/common/git-merge-base.md | 2 +- pages/common/git-merge.md | 4 ++-- pages/common/git-mergetool.md | 6 +++--- pages/common/git-mv.md | 2 +- pages/common/git-prune.md | 4 ++-- pages/common/git-psykorebase.md | 2 +- pages/common/git-reauthor.md | 6 +++--- pages/common/git-release.md | 2 +- pages/common/git-reset.md | 2 +- pages/common/git-restore.md | 10 +++++----- pages/common/git-show-index.md | 2 +- pages/common/git-squash.md | 2 +- pages/common/git-stamp.md | 4 ++-- pages/common/git-stripspace.md | 4 ++-- pages/common/git-summary.md | 2 +- pages/common/git-verify-pack.md | 4 ++-- pages/common/git-verify-tag.md | 2 +- pages/common/git-whatchanged.md | 2 +- 36 files changed, 73 insertions(+), 73 deletions(-) diff --git a/pages/common/git-authors.md b/pages/common/git-authors.md index d227b81e4f..146d001c4a 100644 --- a/pages/common/git-authors.md +++ b/pages/common/git-authors.md @@ -2,11 +2,11 @@ > Generate a list of committers of a Git repository. > Part of `git-extras`. -> More information: . +> More information: . - Print a full list of committers to `stdout` instead of to the `AUTHORS` file: -`git authors --list` +`git authors {{[-l|--list]}}` - Append the list of committers to the `AUTHORS` file and open it in the default editor: diff --git a/pages/common/git-changelog.md b/pages/common/git-changelog.md index 25a56ada99..9cb0ddefef 100644 --- a/pages/common/git-changelog.md +++ b/pages/common/git-changelog.md @@ -2,7 +2,7 @@ > Generate a changelog report from repository commits and tags. > Part of `git-extras`. -> More information: . +> More information: . - Update existing file or create a new `History.md` file with the commit messages since the latest Git tag: @@ -10,19 +10,19 @@ - List commits from the current version: -`git changelog --list` +`git changelog {{[-l|--list]}}` - List a range of commits from the tag named `2.1.0` to now: -`git changelog --list --start-tag {{2.1.0}}` +`git changelog {{[-l|--list]}} {{[-s|--start-tag]}} {{2.1.0}}` - List pretty formatted range of commits between the tag `0.5.0` and the tag `1.0.0`: -`git changelog --start-tag {{0.5.0}} --final-tag {{1.0.0}}` +`git changelog {{[-s|--start-tag]}} {{0.5.0}} {{[-f|--final-tag]}} {{1.0.0}}` - List pretty formatted range of commits between the commit `0b97430` and the tag `1.0.0`: -`git changelog --start-commit {{0b97430}} --final-tag {{1.0.0}}` +`git changelog --start-commit {{0b97430}} {{[-f|--final-tag]}} {{1.0.0}}` - Specify `CHANGELOG.md` as the output file: @@ -30,4 +30,4 @@ - Replace contents of current changelog file entirely: -`git changelog --prune-old` +`git changelog {{[-p|--prune-old]}}` diff --git a/pages/common/git-check-attr.md b/pages/common/git-check-attr.md index cbbda3e43a..64f26987b0 100644 --- a/pages/common/git-check-attr.md +++ b/pages/common/git-check-attr.md @@ -5,7 +5,7 @@ - Check the values of all attributes on a file: -`git check-attr --all {{path/to/file}}` +`git check-attr {{[-a|--all]}} {{path/to/file}}` - Check the value of a specific attribute on a file: @@ -13,7 +13,7 @@ - Check the values of all attributes on specific files: -`git check-attr --all {{path/to/file1 path/to/file2 ...}}` +`git check-attr {{[-a|--all]}} {{path/to/file1 path/to/file2 ...}}` - Check the value of a specific attribute on one or more files: diff --git a/pages/common/git-check-ignore.md b/pages/common/git-check-ignore.md index 628ae1a579..0b1c9df811 100644 --- a/pages/common/git-check-ignore.md +++ b/pages/common/git-check-ignore.md @@ -21,4 +21,4 @@ - Include details about the matching pattern for each path: -`git check-ignore --verbose {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` +`git check-ignore {{[-v|--verbose]}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` diff --git a/pages/common/git-cherry-pick.md b/pages/common/git-cherry-pick.md index 072bb7fd5d..8821fbe661 100644 --- a/pages/common/git-cherry-pick.md +++ b/pages/common/git-cherry-pick.md @@ -18,4 +18,4 @@ - Add the changes of a commit to the working directory, without creating a commit: -`git cherry-pick --no-commit {{commit}}` +`git cherry-pick {{[-n|--no-commit]}} {{commit}}` diff --git a/pages/common/git-cola.md b/pages/common/git-cola.md index 6d89b72e56..07323de62b 100644 --- a/pages/common/git-cola.md +++ b/pages/common/git-cola.md @@ -17,8 +17,8 @@ - Open the Git repository at mentioned path: -`git cola --repo {{path/to/git-repository}}` +`git cola {{[-r|--repo]}} {{path/to/git-repository}}` - Apply the path filter to the status widget: -`git cola --status-filter {{filter}}` +`git cola {{[-s|--status-filter]}} {{filter}}` diff --git a/pages/common/git-commit-tree.md b/pages/common/git-commit-tree.md index 4d174596f9..0ae6b6a553 100644 --- a/pages/common/git-commit-tree.md +++ b/pages/common/git-commit-tree.md @@ -14,7 +14,7 @@ - Create a GPG-signed commit object: -`git commit-tree {{tree}} -m "{{message}}" --gpg-sign` +`git commit-tree {{tree}} -m "{{message}}" {{[-S|--gpg-sign]}}` - Create a commit object with the specified parent commit object: diff --git a/pages/common/git-config.md b/pages/common/git-config.md index 4f598feec9..6c0776b09a 100644 --- a/pages/common/git-config.md +++ b/pages/common/git-config.md @@ -10,7 +10,7 @@ - List local, global or system configuration entries and show their file location: -`git config --list --{{local|global|system}} --show-origin` +`git config {{[-l|--list]}} --{{local|global|system}} --show-origin` - Set the global value of a given configuration entry (in this case an alias): @@ -30,8 +30,8 @@ - Edit the local Git configuration (`.git/config`) in the default editor: -`git config --edit` +`git config {{[-e|--edit]}}` - Edit the global Git configuration (`~/.gitconfig` by default or `$XDG_CONFIG_HOME/git/config` if such a file exists) in the default editor: -`git config --global --edit` +`git config --global {{[-e|--edit]}}` diff --git a/pages/common/git-count-objects.md b/pages/common/git-count-objects.md index c1fc32050e..606016893c 100644 --- a/pages/common/git-count-objects.md +++ b/pages/common/git-count-objects.md @@ -9,12 +9,12 @@ - Display a count of all objects and their total disk usage, displaying sizes in human-readable units: -`git count-objects --human-readable` +`git count-objects {{[-H|--human-readable]}}` - Display more verbose information: -`git count-objects --verbose` +`git count-objects {{[-v|--verbose]}}` - Display more verbose information, displaying sizes in human-readable units: -`git count-objects --human-readable --verbose` +`git count-objects {{[-H|--human-readable]}} {{[-v|--verbose]}}` diff --git a/pages/common/git-extras.md b/pages/common/git-extras.md index eed9e14722..26c01e04cc 100644 --- a/pages/common/git-extras.md +++ b/pages/common/git-extras.md @@ -1,7 +1,7 @@ # git extras > Git extension pack. -> More information: . +> More information: . - Install or upgrade `git-extras` commands: @@ -9,8 +9,8 @@ - Display help: -`git extras --help` +`git extras {{[-h|--help]}}` - Display version: -`git extras --version` +`git extras {{[-v|--version]}}` diff --git a/pages/common/git-feature.md b/pages/common/git-feature.md index e571c53445..8f78f3de02 100644 --- a/pages/common/git-feature.md +++ b/pages/common/git-feature.md @@ -2,7 +2,7 @@ > Create or merge feature branches. > Feature branches obey the format feature/name. -> More information: . +> More information: . - Create and switch to a new feature branch: @@ -18,4 +18,4 @@ - Send changes from a specific feature branch to its remote counterpart: -`git feature {{feature_branch}} --remote {{remote_name}}` +`git feature {{feature_branch}} {{[-r|--remote]}} {{remote_name}}` diff --git a/pages/common/git-for-each-repo.md b/pages/common/git-for-each-repo.md index 8a26426bee..f32a02b26b 100644 --- a/pages/common/git-for-each-repo.md +++ b/pages/common/git-for-each-repo.md @@ -6,8 +6,8 @@ - Run maintenance on each of a list of repositories stored in the `maintenance.repo` user configuration variable: -`git for-each-repo --config={{maintenance.repo}} {{maintenance run}}` +`git for-each-repo --config maintenance.repo {{maintenance run}}` - Run `git pull` on each repository listed in a global configuration variable: -`git for-each-repo --config={{global_configuration_variable}} {{pull}}` +`git for-each-repo --config {{global_configuration_variable}} {{pull}}` diff --git a/pages/common/git-format-patch.md b/pages/common/git-format-patch.md index 6068236fd1..c1866980a4 100644 --- a/pages/common/git-format-patch.md +++ b/pages/common/git-format-patch.md @@ -12,6 +12,6 @@ `git format-patch {{revision_1}}..{{revision_2}}` -- Write a `.patch` file for the 3 latest commits: +- Write a `.patch` file for the `n` latest commits: -`git format-patch -{{3}}` +`git format-patch -{{n}}` diff --git a/pages/common/git-guilt.md b/pages/common/git-guilt.md index 9d4a94f93e..25b47f3191 100644 --- a/pages/common/git-guilt.md +++ b/pages/common/git-guilt.md @@ -2,7 +2,7 @@ > Show total blame count for files with unstaged changes or calculate the change in blame between two revisions. > Part of `git-extras`. -> More information: . +> More information: . - Show total blame count: @@ -22,7 +22,7 @@ - Find blame delta over the last three weeks: -`git guilt 'git log --until="3 weeks ago" --format="%H" {{[-n|--max-count]}} 1'` +`git guilt 'git log --until "3 weeks ago" --format "%H" {{[-n|--max-count]}} 1'` - Find blame delta over the last three weeks (git 1.8.5+): diff --git a/pages/common/git-info.md b/pages/common/git-info.md index 8ed764444d..b80a61f2ee 100644 --- a/pages/common/git-info.md +++ b/pages/common/git-info.md @@ -2,7 +2,7 @@ > Display Git repository information. > Part of `git-extras`. -> More information: . +> More information: . - Display remote locations, remote and local branches, most recent commit data and `.git/config` settings: diff --git a/pages/common/git-instaweb.md b/pages/common/git-instaweb.md index 69de8fad4b..54e9b4f0a7 100644 --- a/pages/common/git-instaweb.md +++ b/pages/common/git-instaweb.md @@ -9,19 +9,19 @@ - Listen only on localhost: -`git instaweb --start --local` +`git instaweb --start {{[-l|--local]}}` - Listen on a specific port: -`git instaweb --start --port {{1234}}` +`git instaweb --start {{[-p|--port]}} {{1234}}` - Use a specified HTTP daemon: -`git instaweb --start --httpd {{lighttpd|apache2|mongoose|plackup|webrick}}` +`git instaweb --start {{[-d|--httpd]}} {{lighttpd|apache2|mongoose|plackup|webrick}}` - Also auto-launch a web browser: -`git instaweb --start --browser` +`git instaweb --start {{[-b|--browser]}}` - Stop the currently running GitWeb server: diff --git a/pages/common/git-lfs.md b/pages/common/git-lfs.md index f1ea6fa660..285dfb6090 100644 --- a/pages/common/git-lfs.md +++ b/pages/common/git-lfs.md @@ -1,7 +1,7 @@ # git lfs > Work with large files in Git repositories. -> More information: . +> More information: . - Initialize Git LFS: diff --git a/pages/common/git-ls-files.md b/pages/common/git-ls-files.md index da64712efb..1d6ca20760 100644 --- a/pages/common/git-ls-files.md +++ b/pages/common/git-ls-files.md @@ -5,16 +5,16 @@ - Show deleted files: -`git ls-files --deleted` +`git ls-files {{[-d|--deleted]}}` - Show modified and deleted files: -`git ls-files --modified` +`git ls-files {{[-m|--modified]}}` - Show ignored and untracked files: -`git ls-files --others` +`git ls-files {{[-o|--others]}}` - Show untracked files, not ignored: -`git ls-files --others --exclude-standard` +`git ls-files {{[-o|--others]}} --exclude-standard` diff --git a/pages/common/git-merge-base.md b/pages/common/git-merge-base.md index d19bbd359c..0621f4945b 100644 --- a/pages/common/git-merge-base.md +++ b/pages/common/git-merge-base.md @@ -9,7 +9,7 @@ - Print all best common ancestors of two commits: -`git merge-base --all {{commit_1}} {{commit_2}}` +`git merge-base {{[-a|--all]}} {{commit_1}} {{commit_2}}` - Check if a commit is an ancestor of a specific commit: diff --git a/pages/common/git-merge.md b/pages/common/git-merge.md index 59f50ed40c..4873e49912 100644 --- a/pages/common/git-merge.md +++ b/pages/common/git-merge.md @@ -9,7 +9,7 @@ - Edit the merge message: -`git merge --edit {{branch_name}}` +`git merge {{[-e|--edit]}} {{branch_name}}` - Merge a branch and create a merge commit: @@ -21,4 +21,4 @@ - Merge using a specific strategy: -`git merge --strategy {{strategy}} --strategy-option {{strategy_option}} {{branch_name}}` +`git merge {{[-s|--strategy]}} {{strategy}} {{[-X|--strategy-option]}} {{strategy_option}} {{branch_name}}` diff --git a/pages/common/git-mergetool.md b/pages/common/git-mergetool.md index aaf3355c79..966f69fa26 100644 --- a/pages/common/git-mergetool.md +++ b/pages/common/git-mergetool.md @@ -13,15 +13,15 @@ - Launch the merge tool identified by a name: -`git mergetool --tool {{tool_name}}` +`git mergetool {{[-t|--tool]}} {{tool_name}}` - Don't prompt before each invocation of the merge tool: -`git mergetool --no-prompt` +`git mergetool {{[-y|--no-prompt]}}` - Explicitly use the GUI merge tool (see the `merge.guitool` configuration variable): -`git mergetool --gui` +`git mergetool {{[-g|--gui]}}` - Explicitly use the regular merge tool (see the `merge.tool` configuration variable): diff --git a/pages/common/git-mv.md b/pages/common/git-mv.md index 33a2467b96..cb6d010db9 100644 --- a/pages/common/git-mv.md +++ b/pages/common/git-mv.md @@ -13,4 +13,4 @@ - Overwrite the file or directory in the target path if it exists: -`git mv --force {{path/to/file_or_directory}} {{path/to/destination}}` +`git mv {{[-f|--force]}} {{path/to/file_or_directory}} {{path/to/destination}}` diff --git a/pages/common/git-prune.md b/pages/common/git-prune.md index 34450cc2f4..855e3292e8 100644 --- a/pages/common/git-prune.md +++ b/pages/common/git-prune.md @@ -6,11 +6,11 @@ - Report what would be removed by Git prune without removing it: -`git prune --dry-run` +`git prune {{[-n|--dry-run]}}` - Prune unreachable objects and display what has been pruned to `stdout`: -`git prune --verbose` +`git prune {{[-v|--verbose]}}` - Prune unreachable objects while showing progress: diff --git a/pages/common/git-psykorebase.md b/pages/common/git-psykorebase.md index 5288ff8d9c..3eaca166f8 100644 --- a/pages/common/git-psykorebase.md +++ b/pages/common/git-psykorebase.md @@ -2,7 +2,7 @@ > Rebase a branch on top of another using a merge commit and only one conflict handling. > Part of `git-extras`. -> More information: . +> More information: . - Rebase the current branch on top of another using a merge commit and only one conflict handling: diff --git a/pages/common/git-reauthor.md b/pages/common/git-reauthor.md index b8308e1dcc..e388b6c806 100644 --- a/pages/common/git-reauthor.md +++ b/pages/common/git-reauthor.md @@ -6,12 +6,12 @@ - Change an author's email and name across the whole Git repository: -`git reauthor --old-email {{old@example.com}} --correct-email {{new@example.com}} --correct-name "{{name}}"` +`git reauthor {{[-o|--old-email]}} {{old@example.com}} {{[-e|--correct-email]}} {{new@example.com}} {{[-n|--correct-name]}} "{{name}}"` - Change the email and name to the ones defined in the Git config: -`git reauthor --old-email {{old@example.com}} --use-config` +`git reauthor {{[-o|--old-email]}} {{old@example.com}} {{[-c|--use-config]}}` - Change the email and name of all commits, regardless of their original author: -`git reauthor --all --correct-email {{name@example.com}} --correct-name {{name}}` +`git reauthor {{[-a|--all]}} {{[-e|--correct-email]}} {{name@example.com}} {{[-n|--correct-name]}} {{name}}` diff --git a/pages/common/git-release.md b/pages/common/git-release.md index a88df2159f..ad0ca02825 100644 --- a/pages/common/git-release.md +++ b/pages/common/git-release.md @@ -2,7 +2,7 @@ > Create a Git tag for a release. > Part of `git-extras`. -> More information: . +> More information: . - Create and push a release: diff --git a/pages/common/git-reset.md b/pages/common/git-reset.md index ab7630b561..e28f9e6164 100644 --- a/pages/common/git-reset.md +++ b/pages/common/git-reset.md @@ -14,7 +14,7 @@ - Interactively unstage portions of a file: -`git reset --patch {{path/to/file}}` +`git reset {{[-p|--patch]}} {{path/to/file}}` - Undo the last commit, keeping its changes (and any further uncommitted changes) in the filesystem: diff --git a/pages/common/git-restore.md b/pages/common/git-restore.md index 40926e3bf0..0aa603beff 100644 --- a/pages/common/git-restore.md +++ b/pages/common/git-restore.md @@ -10,7 +10,7 @@ - Restore an unstaged file to the version of a specific commit: -`git restore --source {{commit}} {{path/to/file}}` +`git restore {{[-s|--source]}} {{commit}} {{path/to/file}}` - Discard all unstaged changes to tracked files: @@ -18,16 +18,16 @@ - Unstage a file: -`git restore --staged {{path/to/file}}` +`git restore {{[-S|--staged]}} {{path/to/file}}` - Unstage all files: -`git restore --staged :/` +`git restore {{[-S|--staged]}} :/` - Discard all changes to files, both staged and unstaged: -`git restore --worktree --staged :/` +`git restore {{[-W|--worktree]}} {{[-S|--staged]}} :/` - Interactively select sections of files to restore: -`git restore --patch` +`git restore {{[-p|--patch]}}` diff --git a/pages/common/git-show-index.md b/pages/common/git-show-index.md index 8bc5058463..69ea6652b0 100644 --- a/pages/common/git-show-index.md +++ b/pages/common/git-show-index.md @@ -9,4 +9,4 @@ - Specify the hash algorithm for the index file (experimental): -`git show-index --object-format={{sha1|sha256}} {{path/to/file}}` +`git show-index --object-format {{sha1|sha256}} {{path/to/file}}` diff --git a/pages/common/git-squash.md b/pages/common/git-squash.md index 160462374e..88e48b036a 100644 --- a/pages/common/git-squash.md +++ b/pages/common/git-squash.md @@ -2,7 +2,7 @@ > Squash multiple commits into a single commit. > Part of `git-extras`. -> More information: . +> More information: . - Merge all commits from a specific branch into the current branch as a single commit: diff --git a/pages/common/git-stamp.md b/pages/common/git-stamp.md index e201b6d3d6..f806d4ed5f 100644 --- a/pages/common/git-stamp.md +++ b/pages/common/git-stamp.md @@ -2,7 +2,7 @@ > Stamp the last commit message, with the possibility to reference the issues numbers from your bug tracker or link to its review page. > Part of `git-extras`. -> More information: . +> More information: . - Stamp the last commit message referencing it with the issue number from your bug tracker: @@ -14,4 +14,4 @@ - Stamp the last commit message replacing previous issues with a new one: -`git stamp --replace {{issue_number}}` +`git stamp {{[-r|--replace]}} {{issue_number}}` diff --git a/pages/common/git-stripspace.md b/pages/common/git-stripspace.md index 80bae31367..4a1530e804 100644 --- a/pages/common/git-stripspace.md +++ b/pages/common/git-stripspace.md @@ -9,8 +9,8 @@ - Trim whitespace and Git comments from a file: -`cat {{path/to/file}} | git stripspace --strip-comments` +`cat {{path/to/file}} | git stripspace {{[-s|--strip-comments]}}` - Convert all lines in a file into Git comments: -`git stripspace --comment-lines < {{path/to/file}}` +`git stripspace {{[-c|--comment-lines]}} < {{path/to/file}}` diff --git a/pages/common/git-summary.md b/pages/common/git-summary.md index 3663d68332..45474d99a7 100644 --- a/pages/common/git-summary.md +++ b/pages/common/git-summary.md @@ -2,7 +2,7 @@ > Display information about a Git repository. > Part of `git-extras`. -> More information: . +> More information: . - Display data about a Git repository: diff --git a/pages/common/git-verify-pack.md b/pages/common/git-verify-pack.md index 8413afccef..648228502f 100644 --- a/pages/common/git-verify-pack.md +++ b/pages/common/git-verify-pack.md @@ -9,8 +9,8 @@ - Verify a packed Git archive file and show verbose details: -`git verify-pack --verbose {{path/to/pack-file}}` +`git verify-pack {{[-v|--verbose]}} {{path/to/pack-file}}` - Verify a packed Git archive file and only display the statistics: -`git verify-pack --stat-only {{path/to/pack-file}}` +`git verify-pack {{[-s|--stat-only]}} {{path/to/pack-file}}` diff --git a/pages/common/git-verify-tag.md b/pages/common/git-verify-tag.md index 25d9e1063b..2b37f79c4c 100644 --- a/pages/common/git-verify-tag.md +++ b/pages/common/git-verify-tag.md @@ -10,7 +10,7 @@ - Check tags for a GPG signature and show details for each tag: -`git verify-tag {{tag1 optional_tag2 ...}} --verbose` +`git verify-tag {{tag1 optional_tag2 ...}} {{[-v|--verbose]}}` - Check tags for a GPG signature and print the raw details: diff --git a/pages/common/git-whatchanged.md b/pages/common/git-whatchanged.md index 6a6ae929ff..69a3dac91b 100644 --- a/pages/common/git-whatchanged.md +++ b/pages/common/git-whatchanged.md @@ -10,7 +10,7 @@ - Display logs and changes for recent commits within the specified time frame: -`git whatchanged --since="{{2 hours ago}}"` +`git whatchanged --since "{{2 hours ago}}"` - Display logs and changes for recent commits for specific files or directories: