2 Title: Collecting information about git
5 Author: Oleg Broytman <phd@phdru.name>
8 Content-Type: text/x-rst
15 This Informational PEP collects information about git. There is, of
16 course, a lot of documentation for git, so the PEP concentrates on
17 more complex issues, scenarios and topics.
19 The plan is to extend the PEP in the future collecting information
20 about equivalence of Mercurial and git scenarios to help migrating
21 Python development from Mercurial to git.
23 The author of the PEP doesn't currently plan to write a Process PEP on
24 migration from Mercurial to git.
30 Git is accompanied with a lot of documentation, both online and
33 Documentation for starters
34 --------------------------
37 <https://www.kernel.org/pub/software/scm/git/docs/gittutorial.html>`_,
39 <https://www.kernel.org/pub/software/scm/git/docs/gittutorial-2.html>`_.
42 <https://www.kernel.org/pub/software/scm/git/docs/user-manual.html>`_.
43 `Everyday GIT With 20 Commands Or So
44 <https://www.kernel.org/pub/software/scm/git/docs/everyday.html>`_.
46 <https://www.kernel.org/pub/software/scm/git/docs/gitworkflows.html>`_.
48 Advanced documentation
49 ----------------------
52 <http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html>`_,
53 with a number of translations.
55 `Pro Git <https://git-scm.com/book>`_. The Book about git. Buy it at
56 Amazon or download in PDF, mobi, or ePub form. Has translations to
57 many different languages. Download Russian translation from `GArik
58 <https://github.com/GArik/progit/wiki>`_.
60 `Git Wiki <https://git.wiki.kernel.org/index.php/Main_Page>`_.
65 Git has builtin help: run ``git help $TOPIC``. For example, run
66 ``git help git`` or ``git help help``.
72 Download and installation
73 -------------------------
75 Unix users: `download and install using your package manager
76 <https://git-scm.com/download/linux>`_.
78 Microsoft Windows: download `git-for-windows
79 <https://github.com/git-for-windows/git/releases>`_ or `msysGit
80 <https://github.com/msysgit/msysgit/releases>`_.
82 MacOS X: use git installed with `XCode
83 <https://developer.apple.com/xcode/downloads/>`_ or download from
84 `MacPorts <https://www.macports.org/ports.php?by=name&substr=git>`_ or
86 <http://sourceforge.net/projects/git-osx-installer/files/>`_ or
87 install git with `Homebrew <http://brew.sh/>`_: ``brew install git``.
89 `git-cola <https://git-cola.github.io/index.html>`_ is a Git GUI
90 written in Python and GPL licensed. Linux, Windows, MacOS X.
92 `TortoiseGit <https://tortoisegit.org/>`_ is a Windows Shell Interface
93 to Git based on TortoiseSVN; open source.
98 This simple code is often appears in documentation, but it is
99 important so let repeat it here. Git stores author and committer
100 names/emails in every commit, so configure your real name and
103 $ git config --global user.name "User Name"
104 $ git config --global user.email user.name@example.org
110 Examples of git commands in this PEP use the following approach. It is
111 supposed that you, the user, works with a local repository named
112 ``python`` that has an upstream remote repo named ``origin``. Your
113 local repo has two branches ``v1`` and ``master``. For most examples
114 the currently checked out branch is ``master``. That is, it's assumed
115 you have done something like that::
117 $ git clone http://git.python.org/python.git
119 $ git branch v1 origin/v1
121 The first command clones remote repository into local directory
122 `python``, creates a new local branch master, sets
123 remotes/origin/master as its upstream remote-tracking branch and
124 checks it out into the working directory.
126 The last command creates a new local branch v1 and sets
127 remotes/origin/v1 as its upstream remote-tracking branch.
129 The same result can be achieved with commands::
131 $ git clone -b v1 http://git.python.org/python.git
133 $ git checkout --track origin/master
135 The last command creates a new local branch master, sets
136 remotes/origin/master as its upstream remote-tracking branch and
137 checks it out into the working directory.
140 Branches and branches
141 =====================
143 Git terminology can be a bit misleading. Take, for example, the term
144 "branch". In git it has two meanings. A branch is a directed line of
145 commits (possibly with merges). And a branch is a label or a pointer
146 assigned to a line of commits. It is important to distinguish when you
147 talk about commits and when about their labels. Lines of commits are
148 by itself unnamed and are usually only lengthening and merging.
149 Labels, on the other hand, can be created, moved, renamed and deleted
153 Remote repositories and remote branches
154 =======================================
156 Remote-tracking branches are branches (pointers to commits) in your
157 local repository. They are there for you to remember what branches and
158 commits have been pulled from and pushed to what remote repos (you can
159 pull from and push to many remotes). Remote-tracking branches live
160 under ``remotes/$REMOTE`` namespaces, e.g. ``remotes/origin/master``.
162 To see the status of remote-tracking branches run::
166 To see local and remote-tracking branches (and tags) pointing to
171 You never do your own development on remote-tracking branches. You
172 create a local branch that has a remote branch as upstream and do
173 development on that local branch. On push git pushes commits to the
174 remote repo and updates remote-tracking branches, on pull git fetches
175 commits from the remote repo, updates remote-tracking branches and
176 fast-forwards, merges or rebases local branches.
178 When you do an initial clone like this::
180 $ git clone -b v1 http://git.python.org/python.git
182 git clones remote repository ``http://git.python.org/python.git`` to
183 directory ``python``, creates a remote named ``origin``, creates
184 remote-tracking branches, creates a local branch ``v1``, configure it
185 to track upstream remotes/origin/v1 branch and checks out ``v1`` into
186 the working directory.
188 Updating local and remote-tracking branches
189 -------------------------------------------
191 There is a major difference between
195 $ git fetch $REMOTE $BRANCH
201 $ git fetch $REMOTE $BRANCH:$BRANCH
203 The first command fetches commits from the named $BRANCH in the
204 $REMOTE repository that are not in your repository, updates
205 remote-tracking branch and leaves the id (the hash) of the head commit
206 in file .git/FETCH_HEAD.
208 The second command fetches commits from the named $BRANCH in the
209 $REMOTE repository that are not in your repository and updates both
210 the local branch $BRANCH and its upstream remote-tracking branch. But
211 it refuses to update branches in case of non-fast-forward. And it
212 refuses to update the current branch (currently checked out branch,
213 where HEAD is pointing to).
215 The first command is used internally by ``git pull``.
219 $ git pull $REMOTE $BRANCH
225 $ git fetch $REMOTE $BRANCH
226 $ git merge FETCH_HEAD
228 Certainly, $BRANCH in that case should be your current branch. If you
229 want to merge a different branch into your current branch first update
230 that non-current branch and then merge::
232 $ git fetch origin v1:v1 # Update v1
233 $ git pull --rebase origin master # Update the current branch master
234 # using rebase instead of merge
237 If you have not yet pushed commits on ``v1``, though, the scenario has
238 to become a bit more complex. Git refuses to update
239 non-fast-forwardable branch, and you don't want to do force-pull
240 because that would remove your non-pushed commits and you would need
241 to recover. So you want to rebase ``v1`` but you cannot rebase
242 non-current branch. Hence, checkout ``v1`` and rebase it before
246 $ git pull --rebase origin v1
247 $ git checkout master
248 $ git pull --rebase origin master
251 It is possible to configure git to make it fetch/pull a few branches
252 or all branches at once, so you can simply run
264 Default remote repository for fetching/pulling is origin. Default set
265 of references to fetch is calculated using matching algorithm: git
266 fetches all branches having the same name on both ends.
271 Pushing is a bit simpler. There is only one command ``push``. When you
276 $ git push origin v1 master
278 git pushes local v1 to remote v1 and local master to remote master.
281 $ git push origin v1:v1 master:master
283 Git pushes commits to the remote repo and updates remote-tracking
284 branches. Git refuses to push commits that aren't fast-forwardable.
285 You can force-push anyway, but please remember - you can force-push to
286 your own repositories but don't force-push to public or shared repos.
287 If you find git refuses to push commits that aren't fast-forwardable,
288 better fetch and merge commits from the remote repo (or rebase your
289 commits on top of the fetched commits), then push. Only force-push if
290 you know what you do and why you do it. See the section `Commit
291 editing and caveats`_ below.
293 It is possible to configure git to make it push a few branches or all
294 branches at once, so you can simply run
306 Default remote repository for pushing is origin. Default set
307 of references to push in git before 2.0 is calculated using matching
308 algorithm: git pushes all branches having the same name on both ends.
309 Default set of references to push in git 2.0+ is calculated using
310 simple algorithm: git pushes the current branch back to its
313 To configure git before 2.0 to the new behaviour run::
315 $ git config push.default simple
317 To configure git 2.0+ to the old behaviour run::
319 $ git config push.default matching
321 Git refuses to push a branch if it's the current branch in the remote
322 non-bare repository: git refuses to update remote working directory.
323 You really should push only to bare repositories. For non-bare
324 repositories git prefers pull-based workflow.
326 When you want to deploy code on a remote host and can only use push
327 (because your workstation is behind a firewall and you cannot pull
328 from it) you do that in two steps using two repositories: you push
329 from the workstation to a bare repo on the remote host, ssh to the
330 remote host and pull from the bare repo to a non-bare deployment repo.
332 That changed in git 2.3, but see `the blog post
333 <https://github.com/blog/1957-git-2-3-has-been-released#push-to-deploy>`_
334 for caveats; in 2.4 the push-to-deploy feature was `further improved
335 <https://github.com/blog/1994-git-2-4-atomic-pushes-push-to-deploy-and-more#push-to-deploy-improvements>`_.
340 Git automatically fetches tags that point to commits being fetched
341 during fetch/pull. To fetch all tags (and commits they point to) run
342 ``git fetch --tags origin``. To fetch some specific tags fetch them
345 $ git fetch origin tag $TAG1 tag $TAG2...
349 $ git fetch origin tag 1.4.2
350 $ git fetch origin v1:v1 tag 2.1.7
352 Git doesn't automatically pushes tags. That allows you to have private
353 tags. To push tags list them explicitly::
355 $ git push origin tag 1.4.2
356 $ git push origin v1 master tag 2.1.7
358 Or push all tags at once::
360 $ git push --tags origin
362 Don't move tags with ``git tag -f`` or remove tags with ``git tag -d``
363 after they have been published.
368 When cloning/fetching/pulling/pushing git copies only database objects
369 (commits, trees, files and tags) and symbolic references (branches and
370 lightweight tags). Everything else is private to the repository and
371 never cloned, updated or pushed. It's your config, your hooks, your
372 private exclude file.
374 If you want to distribute hooks, copy them to the working tree, add,
375 commit, push and instruct the team to update ind install the hook
379 Commit editing and caveats
380 ==========================
382 A warning not to edit published (pushed) commits also appears in
383 documentation but it's repeated here anyway as it's very important.
385 It is possible to recover from forced push but it's PITA for the
386 entire team. Please avoid it.
388 To see what commits have not been published yet compare the head of the
389 branch with its upstream remote-tracking branch::
391 $ git log origin/master..
392 $ git log origin/v1..v1
394 For every branch that has an upstream remote-tracking branch git
395 maintains an alias @{upstream} (short version @{u}), so the commands
396 above can be given as::
401 To see the status of all branches::
405 To compare the status of local branches with a remote repo::
407 $ git remote show origin
409 Read `how to recover from upstream rebase
410 <https://git-scm.com/docs/git-rebase#_recovering_from_upstream_rebase>`_.
411 It is in ``git help rebase``.
413 On the other hand don't be too afraid about commit editing. You can
414 safely edit, remove, reorder, combine and split commits that haven't
415 been pushed yet. You can even push commits to your own (backup) repo,
416 edit them later and force-push edited commits to replace what have
417 already been pushed. Not a problem until commits are in a public
418 or shared repository.
424 Whatever you do, don't panic. Almost anything in git can be undone.
426 git checkout: restore file's content
427 ------------------------------------
429 ``git checkout``, for example, can be used to restore the content of
430 file(s) to that one of a commit. Like this::
432 git checkout HEAD~ README
434 The commands restores the contents of README file to the last but one
435 commit in the current branch. By default the commit ID is simply HEAD;
436 i.e. ``git checkout README`` restores README to the latest commit.
438 (Do not use ``git checkout`` to view a content of a file in a commit,
439 use ``git cat-file -p``; e.g. ``git cat-file -p HEAD~:path/to/README``).
441 git reset: remove (non-pushed) commits
442 --------------------------------------
444 ``git reset`` moves the head of the current branch. The head can be
445 moved to point to any commit but it's often used to remove a commit or
446 a few (preferably, non-pushed ones) from the top of the branch - that
447 is, to move the branch backward in order to undo a few (non-pushed)
450 ``git reset`` has three modes of operation - soft, hard and mixed.
451 Default is mixed. ProGit `explains
452 <https://git-scm.com/book/en/Git-Tools-Reset-Demystified>`_ the
453 difference very clearly. Bare repositories don't have indices or
454 working trees so in a bare repo only soft reset is possible.
459 Mixed mode reset with a path or paths can be used to unstage changes -
460 that is, to remove from index changes added with ``git add`` for
461 committing. See `The Book
462 <https://git-scm.com/book/en/Git-Basics-Undoing-Things>`_ for details
463 about unstaging and other undo tricks.
465 git reflog: reference log
466 -------------------------
468 Removing commits with ``git reset`` or moving the head of a branch
469 sounds dangerous and it is. But there is a way to undo: another
470 reset back to the original commit. Git doesn't remove commits
471 immediately; unreferenced commits (in git terminology they are called
472 "dangling commits") stay in the database for some time (default is two
473 weeks) so you can reset back to it or create a new branch pointing to
476 For every move of a branch's head - with ``git commit``, ``git
477 checkout``, ``git fetch``, ``git pull``, ``git rebase``, ``git reset``
478 and so on - git stores a reference log (reflog for short). For every
479 move git stores where the head was. Command ``git reflog`` can be used
480 to view (and manipulate) the log.
482 In addition to the moves of the head of every branch git stores the
483 moves of the HEAD - a symbolic reference that (usually) names the
484 current branch. HEAD is changed with ``git checkout $BRANCH``.
486 By default ``git reflog`` shows the moves of the HEAD, i.e. the
487 command is equivalent to ``git reflog HEAD``. To show the moves of the
488 head of a branch use the command ``git reflog $BRANCH``.
490 So to undo a ``git reset`` lookup the original commit in ``git
491 reflog``, verify it with ``git show`` or ``git log`` and run ``git
492 reset $COMMIT_ID``. Git stores the move of the branch's head in
493 reflog, so you can undo that undo later again.
495 In a more complex situation you'd want to move some commits along with
496 resetting the head of the branch. Cherry-pick them to the new branch.
497 For example, if you want to reset the branch ``master`` back to the
498 original commit but preserve two commits created in the current branch
501 $ git branch save-master # create a new branch saving master
502 $ git reflog # find the original place of master
503 $ git reset $COMMIT_ID
504 $ git cherry-pick save-master~ save-master
505 $ git branch -D save-master # remove temporary branch
507 git revert: revert a commit
508 ---------------------------
510 ``git revert`` reverts a commit or commits, that is, it creates a new
511 commit or commits that revert(s) the effects of the given commits.
512 It's the only way to undo published commits (``git commit --amend``,
513 ``git rebase`` and ``git reset`` change the branch in
514 non-fast-forwardable ways so they should only be used for non-pushed
517 There is a problem with reverting a merge commit. ``git revert`` can
518 undo the code created by the merge commit but it cannot undo the fact
519 of merge. See the discussion `How to revert a faulty merge
520 <https://www.kernel.org/pub/software/scm/git/docs/howto/revert-a-faulty-merge.html>`_.
522 One thing that cannot be undone
523 -------------------------------
525 Whatever you undo, there is one thing that cannot be undone -
526 overwritten uncommitted changes. Uncommitted changes don't belong to
527 git so git cannot help preserving them.
529 Most of the time git warns you when you're going to execute a command
530 that overwrites uncommitted changes. Git warns you when you try to
531 switch branches with ``git checkout``. It warns you when you're going
532 to rebase with non-clean working tree. It refuses to pull new commits
533 over non-committed files.
535 But there are commands that do exactly that - overwrite files in the
536 working tree. Commands like ``git checkout $PATHs`` or ``git reset
537 --hard`` silently overwrite files including your uncommitted changes.
539 With that in mind you can understand the stance "commit early, commit
540 often". Commit as often as possible. Commit on every save in your
541 editor or IDE. You can edit your commits before pushing - change,
542 reorder, combine, remove. But save your changes in git database,
543 either commit changes or at least stash them with ``git stash``.
549 Internet is full of heated discussions on the topic: "merge or
550 rebase?" Most of them are meaningless. When a DVCS is being used in a
551 big team with a big and complex project with many branches there is
552 simply no way to avoid merges. So the question's diminished to
553 "whether to use rebase, and if yes - when to use rebase?" Considering
554 that it is very much recommended not to rebase published commits the
555 question's diminished even further: "whether to use rebase on
558 That small question is for the team to decide. The author of the PEP
559 recommends to use rebase when pulling, i.e. always do ``git pull
560 --rebase`` or even configure automatic setup of rebase for every new
563 $ git config branch.autosetuprebase always
565 and configure rebase for existing branches::
567 $ git config branch.$NAME.rebase true
571 $ git config branch.v1.rebase true
572 $ git config branch.master.rebase true
574 After that ``git pull origin master`` becomes equivalent to ``git pull
575 --rebase origin master``.
577 In case when merge is preferred it is recommended to create new
578 commits in a separate feature or topic branch while using rebase to
579 update the mainline branch. When the topic branch is ready merge it
580 into mainline. To avoid a tedious task of resolving large number of
581 conflicts at once you can merge the topic branch to the mainline from
582 time to time and switch back to the topic branch to continue working
583 on it. The entire workflow would be something like::
585 $ git checkout -b issue-42 # create a new issue branch and switch to it
586 ...edit/test/commit...
587 $ git checkout master
588 $ git pull --rebase origin master # update master from the upstream
590 $ git branch -d issue-42 # delete the topic branch
591 $ git push origin master
593 When the topic branch is deleted only the label is removed, commits
594 are stayed in the database, they are now merged into master::
596 o--o--o--o--o--M--< master - the mainline branch
598 --*--*--* - the topic branch, now unnamed
600 The topic branch is deleted to avoid cluttering branch namespace with
601 small topic branches. Information on what issue was fixed or what
602 feature was implemented should be in the commit messages.
608 Git has a builtin merge strategy for what Python core developers call
611 $ git merge -s ours v1 # null-merge v1 into master
614 Advanced configuration
615 ======================
620 Git has builtin mechanisms to handle line endings between platforms
621 with different EOL styles. To allow git to do CRLF conversion assign
622 ``text`` attribute to files using `.gitattributes
623 <https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html>`_.
624 For files that have to have specific line ending assign ``eol``
625 attribute. For binary files the attribute is, naturally, ``binary``.
635 To check what attributes git uses for files use ``git check-attr``
636 command. For example::
638 $ git check-attr -a -- \*.py
647 Staging area aka index aka cache is a distinguishing feature of git.
648 Staging area is where git collects patches before committing them.
649 Separation between collecting patches and commit phases provides a
650 very useful feature of git: you can review collected patches before
651 commit and even edit them - remove some hunks, add new hunks and
654 To add files to the index use ``git add``. Collecting patches before
655 committing means you need to do that for every change, not only to add
656 new (untracked) files. To simplify committing in case you just want to
657 commit everything without reviewing run ``git commit --all`` (or just
658 ``-a``) - the command adds every changed tracked file to the index and
659 then commit. To commit a file or files regardless of patches collected
660 in the index run ``git commit [--only|-o] -- $FILE...``.
662 To add hunks of patches to the index use ``git add --patch`` (or just
663 ``-p``). To remove collected files from the index use ``git reset HEAD
664 -- $FILE...`` To add/inspect/remove collected hunks use ``git add
665 --interactive`` (``-i``).
667 To see the diff between the index and the last commit (i.e., collected
668 patches) use ``git diff --cached``. To see the diff between the
669 working tree and the index (i.e., uncollected patches) use just ``git
670 diff``. To see the diff between the working tree and the last commit
671 (i.e., both collected and uncollected patches) run ``git diff HEAD``.
674 <https://git.wiki.kernel.org/index.php/WhatIsTheIndex>`_ and
675 `IndexCommandQuickref
676 <https://git.wiki.kernel.org/index.php/IndexCommandQuickref>`_ in Git
683 Rerere is a mechanism that helps to resolve repeated merge conflicts.
684 The most frequent source of recurring merge conflicts are topic
685 branches that are merged into mainline and then the merge commits are
686 removed; that's often performed to test the topic branches and train
687 rerere; merge commits are removed to have clean linear history and
688 finish the topic branch with only one last merge commit.
690 Rerere works by remembering the states of tree before and after a
691 successful commit. That way rerere can automatically resolve conflicts
692 if they appear in the same files.
694 Rerere can be used manually with ``git rerere`` command but most often
695 it's used automatically. Enable rerere with these commands in a
698 $ git config rerere.enabled true
699 $ git config rerere.autoupdate true
701 You don't need to turn rerere on globally - you don't want rerere in
702 bare repositories or repositories without branches; you only need
703 rerere in repos where you often perform merges and resolve merge
706 See `Rerere <https://git-scm.com/book/en/Git-Tools-Rerere>`_ in The
713 Git object database and other files/directories under ``.git`` require
714 periodic maintenance and cleanup. For example, commit editing left
715 unreferenced objects (dangling objects, in git terminology) and these
716 objects should be pruned to avoid collecting cruft in the DB. The
717 command ``git gc`` is used for maintenance. Git automatically runs
718 ``git gc --auto`` as a part of some commands to do quick maintenance.
719 Users are recommended to run ``git gc --aggressive`` from time to
720 time; ``git help gc`` recommends to run it every few hundred
721 changesets; for more intensive projects it should be something like
722 once a week and less frequently (biweekly or monthly) for lesser
725 ``git gc --aggressive`` not only removes dangling objects, it also
726 repacks object database into indexed and better optimized pack(s); it
727 also packs symbolic references (branches and tags). Another way to do
728 it is to run ``git repack``.
730 There is a well-known `message
731 <https://gcc.gnu.org/ml/gcc/2007-12/msg00165.html>`_ from Linus
732 Torvalds regarding "stupidity" of ``git gc --aggressive``. The message
733 can safely be ignored now. It is old and outdated, ``git gc
734 --aggressive`` became much better since that time.
736 For those who still prefer ``git repack`` over ``git gc --aggressive``
737 the recommended parameters are ``git repack -a -d -f --depth=20
738 --window=250``. See `this detailed experiment
739 <http://vcscompare.blogspot.ru/2008/06/git-repack-parameters.html>`_
740 for explanation on the effects of these parameters.
742 From time to time run ``git fsck [--strict]`` to verify integrity of
743 the database. ``git fsck`` may produce a list of dangling objects;
744 that's not an error, just a reminder to perform regular maintenance.
750 Command-line options and arguments
751 ----------------------------------
754 <https://www.kernel.org/pub/software/scm/git/docs/gitcli.html>`_
755 recommends not to combine short options/flags. Most of the times it
756 works: ``git commit -av`` works perfectly, but there are situations
757 when it doesn't. E.g., ``git log -p -5`` cannot be combined as ``git
760 Some options have arguments, some even have default arguments. In that
761 case the argument for such option must be spelled in a sticky way:
762 ``-Oarg``, never ``-O arg`` because for an option that has a default
763 argument the latter means "use default value for option ``-O`` and
764 pass ``arg`` further to the option parser". For example, ``git grep``
765 has an option ``-O`` that passes found files to a program; default
766 program for ``-O`` is pager (usually ``less``), but you can use your
769 $ git grep -Ovim # but not -O vim
771 BTW, there is a difference between running ``git grep -O`` and ``git
772 grep -Oless`` - in the latter case ``git grep`` passes ``+/pattern``
778 It's a bit hard to type ``git rebase --interactive --preserve-merges
779 HEAD~5`` manually even for those who are happy to use command-line,
780 and this is where shell completion is of great help. Bash/zsh come
781 with programmable completion, often automatically preinstalled and
782 enabled, so if you have bash/zsh and git installed, chances are you
783 are already done - just go and use it at the command-line.
785 If you don't have necessary bits preinstalled, install and enable
786 bash_completion package. If you want to upgrade your git completion to
787 the latest and greatest download necessary file from `git contrib
788 <https://git.kernel.org/cgit/git/git.git/tree/contrib/completion>`_.
790 Git-for-windows comes with git-bash for which bash completion is
791 installed and enabled.
796 For command-line lovers shell prompt can carry a lot of useful
797 information. To include git information in the prompt use
799 <https://git.kernel.org/cgit/git/git.git/tree/contrib/completion/git-prompt.sh>`_.
800 Read the detailed instructions in the file.
802 Search the Net for "git prompt" to find other prompt variants.
808 The simplest way to publish a repository or a group of repositories is
809 ``git daemon``. The daemon provides anonymous access, by default it is
810 read-only. The repositories are accessible by git protocol (git://
811 URLs). Write access can be enabled but the protocol lacks any
812 authentication means, so it should be enabled only within a trusted
813 LAN. See ``git help daemon`` for details.
815 Git over ssh provides authentication and repo-level authorisation as
816 repositories can be made user- or group-writeable (see parameter
817 ``core.sharedRepository`` in ``git help config``). If that's too
818 permissive or too restrictive for some project's needs there is a
819 wrapper `gitolite <http://gitolite.com/gitolite/index.html>`_ that can
820 be configured to allow access with great granularity; gitolite has a
821 lot of documentation.
823 TODO: gitweb; cgit; Kallithea; pagure; gogs and gitea; gitlab.
825 https://git.kernel.org/cgit/git/git.git/tree/gitweb
827 http://git.zx2c4.com/cgit/
829 https://kallithea-scm.org/
833 http://gogs.io/ and http://gitea.io/
835 https://about.gitlab.com/
838 From Mercurial to git
839 =====================
841 Mercurial for Git users https://mercurial.selenic.com/wiki/GitConcepts
843 https://github.com/felipec/git-remote-hg
845 https://hg-git.github.io/
857 This document has been placed in the public domain.
864 indent-tabs-mode: nil
865 sentence-end-double-space: t
869 vim: set fenc=us-ascii tw=70 :