X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=pep-git.txt;h=f9cae0363c598689c42138de724a43bd2431f002;hb=5688e11691e873b5f624275b92f7159f3f7c3acf;hp=f2ce4c151d60a78928bd3879afbe2ec018f952c8;hpb=1b20b4ee8cec8661e6ae46b994b38fb25a22915f;p=git-wiki.git diff --git a/pep-git.txt b/pep-git.txt index f2ce4c1..f9cae03 100644 --- a/pep-git.txt +++ b/pep-git.txt @@ -14,7 +14,7 @@ Abstract This Informational PEP collects information about git. There is, of course, a lot of documentation for git, so the PEP concentrates on -more complex issues, scenarios and topics. +more complex issues, scenarios and examples. The plan is to extend the PEP in the future collecting information about equivalence of Mercurial and git scenarios to help migrating @@ -30,6 +30,7 @@ Documentation Git is accompanied with a lot of documentation, both online and offline. + Documentation for starters -------------------------- @@ -45,6 +46,7 @@ Git Tutorial: `part 1 `Git workflows `_. + Advanced documentation ---------------------- @@ -59,6 +61,7 @@ many different languages. Download Russian translation from `GArik `Git Wiki `_. + Offline documentation --------------------- @@ -92,6 +95,7 @@ written in Python and GPL licensed. Linux, Windows, MacOS X. `TortoiseGit `_ is a Windows Shell Interface to Git based on TortoiseSVN; open source. + Initial configuration --------------------- @@ -114,7 +118,7 @@ local repo has two branches ``v1`` and ``master``. For most examples the currently checked out branch is ``master``. That is, it's assumed you have done something like that:: - $ git clone http://git.python.org/python.git + $ git clone https://git.python.org/python.git $ cd python $ git branch v1 origin/v1 @@ -128,7 +132,7 @@ remotes/origin/v1 as its upstream remote-tracking branch. The same result can be achieved with commands:: - $ git clone -b v1 http://git.python.org/python.git + $ git clone -b v1 https://git.python.org/python.git $ cd python $ git checkout --track origin/master @@ -177,12 +181,14 @@ fast-forwards, merges or rebases local branches. When you do an initial clone like this:: - $ git clone -b v1 http://git.python.org/python.git + $ git clone -b v1 https://git.python.org/python.git + +git clones remote repository ``https://git.python.org/python.git`` to +directory ``python``, creates a remote named ``origin``, creates +remote-tracking branches, creates a local branch ``v1``, configure it +to track upstream remotes/origin/v1 branch and checks out ``v1`` into +the working directory. -git clones remote repository ``http://git.python.org/python.git`` to -directory ``python``, creates remote-tracking branches, creates a -local branch ``v1``, configure it to track upstream remotes/origin/v1 -branch and checks out ``v1`` into the working directory. Updating local and remote-tracking branches ------------------------------------------- @@ -208,7 +214,8 @@ The second command fetches commits from the named $BRANCH in the $REMOTE repository that are not in your repository and updates both the local branch $BRANCH and its upstream remote-tracking branch. But it refuses to update branches in case of non-fast-forward. And it -refuses to update the current branch. +refuses to update the current branch (currently checked out branch, +where HEAD is pointing to). The first command is used internally by ``git pull``. @@ -353,9 +360,14 @@ tags. To push tags list them explicitly:: $ git push origin tag 1.4.2 $ git push origin v1 master tag 2.1.7 +Or push all tags at once:: + + $ git push --tags origin + Don't move tags with ``git tag -f`` or remove tags with ``git tag -d`` after they have been published. + Private information ''''''''''''''''''' @@ -417,6 +429,7 @@ Undo Whatever you do, don't panic. Almost anything in git can be undone. + git checkout: restore file's content ------------------------------------ @@ -432,6 +445,7 @@ i.e. ``git checkout README`` restores README to the latest commit. (Do not use ``git checkout`` to view a content of a file in a commit, use ``git cat-file -p``; e.g. ``git cat-file -p HEAD~:path/to/README``). + git reset: remove (non-pushed) commits -------------------------------------- @@ -447,6 +461,7 @@ Default is mixed. ProGit `explains difference very clearly. Bare repositories don't have indices or working trees so in a bare repo only soft reset is possible. + Unstaging ''''''''' @@ -456,6 +471,7 @@ committing. See `The Book `_ for details about unstaging and other undo tricks. + git reflog: reference log ------------------------- @@ -498,6 +514,7 @@ do something like:: $ git cherry-pick save-master~ save-master $ git branch -D save-master # remove temporary branch + git revert: revert a commit --------------------------- @@ -513,6 +530,7 @@ undo the code created by the merge commit but it cannot undo the fact of merge. See the discussion `How to revert a faulty merge `_. + One thing that cannot be undone ------------------------------- @@ -766,6 +784,7 @@ BTW, there is a difference between running ``git grep -O`` and ``git grep -Oless`` - in the latter case ``git grep`` passes ``+/pattern`` option to less. + bash/zsh completion ------------------- @@ -784,6 +803,7 @@ the latest and greatest download necessary file from `git contrib Git-for-windows comes with git-bash for which bash completion is installed and enabled. + bash/zsh prompt --------------- @@ -814,29 +834,55 @@ wrapper `gitolite `_ that can be configured to allow access with great granularity; gitolite has a lot of documentation. -TODO: gitweb; cgit; Kallithea; pagure; gogs and gitea; gitlab. - -https://git.kernel.org/cgit/git/git.git/tree/gitweb +Web interface to browse repositories can be created using `gitweb +`_ and `cgit +`_. Both are CGI scripts (written in +Perl and C). In addition to web interface both provide read-only dumb +http access for git (http(s):// URLs). -http://git.zx2c4.com/cgit/ +There are also more advanced web-based development environments that +include ability to manage users, groups and projects; private, group +and public repositories; and often include issue trackers, wiki pages, +pull requests and other tools for development and communication. Among +these environments are `Kallithea `_ and +`pagure `_, both are written in Python; pagure was +written by Fedora developers and is being used to develop some Fedora +projects. `Gogs `_ is written in Go; there is a fork +`Gitea `_. -https://kallithea-scm.org/ +And last but not least `Gitlab `_. It's +perhaps the most advanced git web-based development environment. +Written in Ruby, community edition is free and open source (MIT +license). -https://pagure.io/ -http://gogs.io/ and http://gitea.io/ +From Mercurial to git +===================== -https://about.gitlab.com/ +There are many tools to convert Mercurial repositories to git. The +most famous are, perhaps, `hg-git `_ and +`fast-export `_ (many years ago +it was known under the name ``hg2git``). +But a better tool, perhaps the best, is `git-remote-hg +`_. It provides transparent +bidirectional access (pull and push) to Mercurial repositories from +git. The author wrote a `comparison of alternatives +`_ +that seems to be mostly unbiased. -From Mercurial to git -===================== +To use git-remote-hg, install or clone it, add to your PATH (or copy +script ``git-remote-hg`` to a directory that's already in PATH) and +prepend ``hg::`` to Mercurial URLs. For example:: -Mercurial for Git users https://mercurial.selenic.com/wiki/GitConcepts + $ git clone https://github.com/felipec/git-remote-hg.git + $ PATH=$PATH:"`pwd`"/git-remote-hg + $ git clone hg::https://hg.python.org/peps/ PEPs -https://github.com/felipec/git-remote-hg +To work with the repository just use normal ``git fetch/pull/push`` +commands. -https://hg-git.github.io/ +Mercurial for Git users https://mercurial.selenic.com/wiki/GitConcepts References