man7/giteveryday.7

   1 '\" t
   2 .\"     Title: giteveryday
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-09-25
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.47.0.rc0
   8 .\"  Language: English
   9 .\"
  10 .TH "GITEVERYDAY" "7" "2024-09-25" "Git 2\&.47\&.0\&.rc0" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 giteveryday \- A useful minimum set of commands for Everyday Git
  32 .SH "SYNOPSIS"
  33 .sp
  34 Everyday Git With 20 Commands Or So
  35 .SH "DESCRIPTION"
  36 .sp
  37 Git users can broadly be grouped into four categories for the purposes of describing here a small set of useful commands for everyday Git\&.
  38 .sp
  39 .RS 4
  40 .ie n \{\
  41 \h'-04'\(bu\h'+03'\c
  42 .\}
  43 .el \{\
  44 .sp -1
  45 .IP \(bu 2.3
  46 .\}
  47 Individual Developer (Standalone)
  48 commands are essential for anybody who makes a commit, even for somebody who works alone\&.
  49 .RE
  50 .sp
  51 .RS 4
  52 .ie n \{\
  53 \h'-04'\(bu\h'+03'\c
  54 .\}
  55 .el \{\
  56 .sp -1
  57 .IP \(bu 2.3
  58 .\}
  59 If you work with other people, you will need commands listed in the
  60 Individual Developer (Participant)
  61 section as well\&.
  62 .RE
  63 .sp
  64 .RS 4
  65 .ie n \{\
  66 \h'-04'\(bu\h'+03'\c
  67 .\}
  68 .el \{\
  69 .sp -1
  70 .IP \(bu 2.3
  71 .\}
  72 People who play the
  73 Integrator
  74 role need to learn some more commands in addition to the above\&.
  75 .RE
  76 .sp
  77 .RS 4
  78 .ie n \{\
  79 \h'-04'\(bu\h'+03'\c
  80 .\}
  81 .el \{\
  82 .sp -1
  83 .IP \(bu 2.3
  84 .\}
  85 Repository Administration
  86 commands are for system administrators who are responsible for the care and feeding of Git repositories\&.
  87 .RE
  88 .SH "INDIVIDUAL DEVELOPER (STANDALONE)"
  89 .sp
  90 A standalone individual developer does not exchange patches with other people, and works alone in a single repository, using the following commands\&.
  91 .sp
  92 .RS 4
  93 .ie n \{\
  94 \h'-04'\(bu\h'+03'\c
  95 .\}
  96 .el \{\
  97 .sp -1
  98 .IP \(bu 2.3
  99 .\}
 100 \fBgit-init\fR(1)
 101 to create a new repository\&.
 102 .RE
 103 .sp
 104 .RS 4
 105 .ie n \{\
 106 \h'-04'\(bu\h'+03'\c
 107 .\}
 108 .el \{\
 109 .sp -1
 110 .IP \(bu 2.3
 111 .\}
 112 \fBgit-log\fR(1)
 113 to see what happened\&.
 114 .RE
 115 .sp
 116 .RS 4
 117 .ie n \{\
 118 \h'-04'\(bu\h'+03'\c
 119 .\}
 120 .el \{\
 121 .sp -1
 122 .IP \(bu 2.3
 123 .\}
 124 \fBgit-switch\fR(1)
 125 and
 126 \fBgit-branch\fR(1)
 127 to switch branches\&.
 128 .RE
 129 .sp
 130 .RS 4
 131 .ie n \{\
 132 \h'-04'\(bu\h'+03'\c
 133 .\}
 134 .el \{\
 135 .sp -1
 136 .IP \(bu 2.3
 137 .\}
 138 \fBgit-add\fR(1)
 139 to manage the index file\&.
 140 .RE
 141 .sp
 142 .RS 4
 143 .ie n \{\
 144 \h'-04'\(bu\h'+03'\c
 145 .\}
 146 .el \{\
 147 .sp -1
 148 .IP \(bu 2.3
 149 .\}
 150 \fBgit-diff\fR(1)
 151 and
 152 \fBgit-status\fR(1)
 153 to see what you are in the middle of doing\&.
 154 .RE
 155 .sp
 156 .RS 4
 157 .ie n \{\
 158 \h'-04'\(bu\h'+03'\c
 159 .\}
 160 .el \{\
 161 .sp -1
 162 .IP \(bu 2.3
 163 .\}
 164 \fBgit-commit\fR(1)
 165 to advance the current branch\&.
 166 .RE
 167 .sp
 168 .RS 4
 169 .ie n \{\
 170 \h'-04'\(bu\h'+03'\c
 171 .\}
 172 .el \{\
 173 .sp -1
 174 .IP \(bu 2.3
 175 .\}
 176 \fBgit-restore\fR(1)
 177 to undo changes\&.
 178 .RE
 179 .sp
 180 .RS 4
 181 .ie n \{\
 182 \h'-04'\(bu\h'+03'\c
 183 .\}
 184 .el \{\
 185 .sp -1
 186 .IP \(bu 2.3
 187 .\}
 188 \fBgit-merge\fR(1)
 189 to merge between local branches\&.
 190 .RE
 191 .sp
 192 .RS 4
 193 .ie n \{\
 194 \h'-04'\(bu\h'+03'\c
 195 .\}
 196 .el \{\
 197 .sp -1
 198 .IP \(bu 2.3
 199 .\}
 200 \fBgit-rebase\fR(1)
 201 to maintain topic branches\&.
 202 .RE
 203 .sp
 204 .RS 4
 205 .ie n \{\
 206 \h'-04'\(bu\h'+03'\c
 207 .\}
 208 .el \{\
 209 .sp -1
 210 .IP \(bu 2.3
 211 .\}
 212 \fBgit-tag\fR(1)
 213 to mark a known point\&.
 214 .RE
 215 .SS "Examples"
 216 .PP
 217 Use a tarball as a starting point for a new repository\&.
 218 .RS 4
 219 .sp
 220 .if n \{\
 221 .RS 4
 222 .\}
 223 .nf
 224 $ tar zxf frotz\&.tar\&.gz
 225 $ cd frotz
 226 $ git init
 227 $ git add \&. \fB(1)\fR
 228 $ git commit \-m "import of frotz source tree\&."
 229 $ git tag v2\&.43 \fB(2)\fR
 230 .fi
 231 .if n \{\
 232 .RE
 233 .\}
 234 .TS
 235 tab(:);
 236 r lw(\n(.lu*75u/100u).
 237 \fB1.\fR\h'-2n':T{
 238 add everything under the current directory\&.
 239 T}
 240 \fB2.\fR\h'-2n':T{
 241 make a lightweight, unannotated tag\&.
 242 T}
 243 .TE
 244 .RE
 245 .PP
 246 Create a topic branch and develop\&.
 247 .RS 4
 248 .sp
 249 .if n \{\
 250 .RS 4
 251 .\}
 252 .nf
 253 $ git switch \-c alsa\-audio \fB(1)\fR
 254 $ edit/compile/test
 255 $ git restore curses/ux_audio_oss\&.c \fB(2)\fR
 256 $ git add curses/ux_audio_alsa\&.c \fB(3)\fR
 257 $ edit/compile/test
 258 $ git diff HEAD \fB(4)\fR
 259 $ git commit \-a \-s \fB(5)\fR
 260 $ edit/compile/test
 261 $ git diff HEAD^ \fB(6)\fR
 262 $ git commit \-a \-\-amend \fB(7)\fR
 263 $ git switch master \fB(8)\fR
 264 $ git merge alsa\-audio \fB(9)\fR
 265 $ git log \-\-since=\*(Aq3 days ago\*(Aq \fB(10)\fR
 266 $ git log v2\&.43\&.\&. curses/ \fB(11)\fR
 267 .fi
 268 .if n \{\
 269 .RE
 270 .\}
 271 .TS
 272 tab(:);
 273 r lw(\n(.lu*75u/100u).
 274 \fB1.\fR\h'-2n':T{
 275 create a new topic branch\&.
 276 T}
 277 \fB2.\fR\h'-2n':T{
 278 revert your botched changes in
 279 \fBcurses/ux_audio_oss\&.c\fR\&.
 280 T}
 281 \fB3.\fR\h'-2n':T{
 282 you need to tell Git if you added a new file; removal and modification will be caught if you do
 283 \fBgit commit \-a\fR
 284 later\&.
 285 T}
 286 \fB4.\fR\h'-2n':T{
 287 to see what changes you are committing\&.
 288 T}
 289 \fB5.\fR\h'-2n':T{
 290 commit everything, as you have tested, with your sign\-off\&.
 291 T}
 292 \fB6.\fR\h'-2n':T{
 293 look at all your changes including the previous commit\&.
 294 T}
 295 \fB7.\fR\h'-2n':T{
 296 amend the previous commit, adding all your new changes, using your original message\&.
 297 T}
 298 \fB8.\fR\h'-2n':T{
 299 switch to the master branch\&.
 300 T}
 301 \fB9.\fR\h'-2n':T{
 302 merge a topic branch into your master branch\&.
 303 T}
 304 \fB10.\fR\h'-2n':T{
 305 review commit logs; other forms to limit output can be combined and include
 306 \fB\-10\fR
 307 (to show up to 10 commits),
 308 \fB\-\-until=2005\-12\-10\fR, etc\&.
 309 T}
 310 \fB11.\fR\h'-2n':T{
 311 view only the changes that touch what\(cqs in
 312 \fBcurses/\fR
 313 directory, since
 314 \fBv2\&.43\fR
 315 tag\&.
 316 T}
 317 .TE
 318 .RE
 319 .SH "INDIVIDUAL DEVELOPER (PARTICIPANT)"
 320 .sp
 321 A developer working as a participant in a group project needs to learn how to communicate with others, and uses these commands in addition to the ones needed by a standalone developer\&.
 322 .sp
 323 .RS 4
 324 .ie n \{\
 325 \h'-04'\(bu\h'+03'\c
 326 .\}
 327 .el \{\
 328 .sp -1
 329 .IP \(bu 2.3
 330 .\}
 331 \fBgit-clone\fR(1)
 332 from the upstream to prime your local repository\&.
 333 .RE
 334 .sp
 335 .RS 4
 336 .ie n \{\
 337 \h'-04'\(bu\h'+03'\c
 338 .\}
 339 .el \{\
 340 .sp -1
 341 .IP \(bu 2.3
 342 .\}
 343 \fBgit-pull\fR(1)
 344 and
 345 \fBgit-fetch\fR(1)
 346 from "origin" to keep up\-to\-date with the upstream\&.
 347 .RE
 348 .sp
 349 .RS 4
 350 .ie n \{\
 351 \h'-04'\(bu\h'+03'\c
 352 .\}
 353 .el \{\
 354 .sp -1
 355 .IP \(bu 2.3
 356 .\}
 357 \fBgit-push\fR(1)
 358 to shared repository, if you adopt CVS style shared repository workflow\&.
 359 .RE
 360 .sp
 361 .RS 4
 362 .ie n \{\
 363 \h'-04'\(bu\h'+03'\c
 364 .\}
 365 .el \{\
 366 .sp -1
 367 .IP \(bu 2.3
 368 .\}
 369 \fBgit-format-patch\fR(1)
 370 to prepare e\-mail submission, if you adopt Linux kernel\-style public forum workflow\&.
 371 .RE
 372 .sp
 373 .RS 4
 374 .ie n \{\
 375 \h'-04'\(bu\h'+03'\c
 376 .\}
 377 .el \{\
 378 .sp -1
 379 .IP \(bu 2.3
 380 .\}
 381 \fBgit-send-email\fR(1)
 382 to send your e\-mail submission without corruption by your MUA\&.
 383 .RE
 384 .sp
 385 .RS 4
 386 .ie n \{\
 387 \h'-04'\(bu\h'+03'\c
 388 .\}
 389 .el \{\
 390 .sp -1
 391 .IP \(bu 2.3
 392 .\}
 393 \fBgit-request-pull\fR(1)
 394 to create a summary of changes for your upstream to pull\&.
 395 .RE
 396 .SS "Examples"
 397 .PP
 398 Clone the upstream and work on it\&. Feed changes to upstream\&.
 399 .RS 4
 400 .sp
 401 .if n \{\
 402 .RS 4
 403 .\}
 404 .nf
 405 $ git clone git://git\&.kernel\&.org/pub/scm/\&.\&.\&./torvalds/linux\-2\&.6 my2\&.6
 406 $ cd my2\&.6
 407 $ git switch \-c mine master \fB(1)\fR
 408 $ edit/compile/test; git commit \-a \-s \fB(2)\fR
 409 $ git format\-patch master \fB(3)\fR
 410 $ git send\-email \-\-to="person <email@example\&.com>" 00*\&.patch \fB(4)\fR
 411 $ git switch master \fB(5)\fR
 412 $ git pull \fB(6)\fR
 413 $ git log \-p ORIG_HEAD\&.\&. arch/i386 include/asm\-i386 \fB(7)\fR
 414 $ git ls\-remote \-\-heads http://git\&.kernel\&.org/\&.\&.\&./jgarzik/libata\-dev\&.git \fB(8)\fR
 415 $ git pull git://git\&.kernel\&.org/pub/\&.\&.\&./jgarzik/libata\-dev\&.git ALL \fB(9)\fR
 416 $ git reset \-\-hard ORIG_HEAD \fB(10)\fR
 417 $ git gc \fB(11)\fR
 418 .fi
 419 .if n \{\
 420 .RE
 421 .\}
 422 .TS
 423 tab(:);
 424 r lw(\n(.lu*75u/100u).
 425 \fB1.\fR\h'-2n':T{
 426 checkout a new branch
 427 \fBmine\fR
 428 from master\&.
 429 T}
 430 \fB2.\fR\h'-2n':T{
 431 repeat as needed\&.
 432 T}
 433 \fB3.\fR\h'-2n':T{
 434 extract patches from your branch, relative to master,
 435 T}
 436 \fB4.\fR\h'-2n':T{
 437 and email them\&.
 438 T}
 439 \fB5.\fR\h'-2n':T{
 440 return to
 441 \fBmaster\fR, ready to see what\(cqs new
 442 T}
 443 \fB6.\fR\h'-2n':T{
 444 \fBgit pull\fR
 445 fetches from
 446 \fBorigin\fR
 447 by default and merges into the current branch\&.
 448 T}
 449 \fB7.\fR\h'-2n':T{
 450 immediately after pulling, look at the changes done upstream since last time we checked, only in the area we are interested in\&.
 451 T}
 452 \fB8.\fR\h'-2n':T{
 453 check the branch names in an external repository (if not known)\&.
 454 T}
 455 \fB9.\fR\h'-2n':T{
 456 fetch from a specific branch
 457 \fBALL\fR
 458 from a specific repository and merge it\&.
 459 T}
 460 \fB10.\fR\h'-2n':T{
 461 revert the pull\&.
 462 T}
 463 \fB11.\fR\h'-2n':T{
 464 garbage collect leftover objects from reverted pull\&.
 465 T}
 466 .TE
 467 .RE
 468 .PP
 469 Push into another repository\&.
 470 .RS 4
 471 .sp
 472 .if n \{\
 473 .RS 4
 474 .\}
 475 .nf
 476 satellite$ git clone mothership:frotz frotz \fB(1)\fR
 477 satellite$ cd frotz
 478 satellite$ git config \-\-get\-regexp \*(Aq^(remote|branch)\e\&.\*(Aq \fB(2)\fR
 479 remote\&.origin\&.url mothership:frotz
 480 remote\&.origin\&.fetch refs/heads/*:refs/remotes/origin/*
 481 branch\&.master\&.remote origin
 482 branch\&.master\&.merge refs/heads/master
 483 satellite$ git config remote\&.origin\&.push \e
 484            +refs/heads/*:refs/remotes/satellite/* \fB(3)\fR
 485 satellite$ edit/compile/test/commit
 486 satellite$ git push origin \fB(4)\fR
 487
 488 mothership$ cd frotz
 489 mothership$ git switch master
 490 mothership$ git merge satellite/master \fB(5)\fR
 491 .fi
 492 .if n \{\
 493 .RE
 494 .\}
 495 .TS
 496 tab(:);
 497 r lw(\n(.lu*75u/100u).
 498 \fB1.\fR\h'-2n':T{
 499 mothership machine has a frotz repository under your home directory; clone from it to start a repository on the satellite machine\&.
 500 T}
 501 \fB2.\fR\h'-2n':T{
 502 clone sets these configuration variables by default\&. It arranges
 503 \fBgit pull\fR
 504 to fetch and store the branches of mothership machine to local
 505 \fBremotes/origin/*\fR
 506 remote\-tracking branches\&.
 507 T}
 508 \fB3.\fR\h'-2n':T{
 509 arrange
 510 \fBgit push\fR
 511 to push all local branches to their corresponding branch of the mothership machine\&.
 512 T}
 513 \fB4.\fR\h'-2n':T{
 514 push will stash all our work away on
 515 \fBremotes/satellite/*\fR
 516 remote\-tracking branches on the mothership machine\&. You could use this as a back\-up method\&. Likewise, you can pretend that mothership "fetched" from you (useful when access is one sided)\&.
 517 T}
 518 \fB5.\fR\h'-2n':T{
 519 on mothership machine, merge the work done on the satellite machine into the master branch\&.
 520 T}
 521 .TE
 522 .RE
 523 .PP
 524 Branch off of a specific tag\&.
 525 .RS 4
 526 .sp
 527 .if n \{\
 528 .RS 4
 529 .\}
 530 .nf
 531 $ git switch \-c private2\&.6\&.14 v2\&.6\&.14 \fB(1)\fR
 532 $ edit/compile/test; git commit \-a
 533 $ git checkout master
 534 $ git cherry\-pick v2\&.6\&.14\&.\&.private2\&.6\&.14 \fB(2)\fR
 535 .fi
 536 .if n \{\
 537 .RE
 538 .\}
 539 .TS
 540 tab(:);
 541 r lw(\n(.lu*75u/100u).
 542 \fB1.\fR\h'-2n':T{
 543 create a private branch based on a well known (but somewhat behind) tag\&.
 544 T}
 545 \fB2.\fR\h'-2n':T{
 546 forward port all changes in
 547 \fBprivate2\&.6\&.14\fR
 548 branch to
 549 \fBmaster\fR
 550 branch without a formal "merging"\&. Or longhand
 551
 552 \fBgit format\-patch \-k \-m \-\-stdout v2\&.6\&.14\&.\&.private2\&.6\&.14 | git am \-3 \-k\fR
 553 T}
 554 .TE
 555 .RE
 556 .sp
 557 An alternate participant submission mechanism is using the \fBgit request\-pull\fR or pull\-request mechanisms (e\&.g\&. as used on GitHub (www\&.github\&.com) to notify your upstream of your contribution\&.
 558 .SH "INTEGRATOR"
 559 .sp
 560 A fairly central person acting as the integrator in a group project receives changes made by others, reviews and integrates them and publishes the result for others to use, using these commands in addition to the ones needed by participants\&.
 561 .sp
 562 This section can also be used by those who respond to \fBgit request\-pull\fR or pull\-request on GitHub (www\&.github\&.com) to integrate the work of others into their history\&. A sub\-area lieutenant for a repository will act both as a participant and as an integrator\&.
 563 .sp
 564 .RS 4
 565 .ie n \{\
 566 \h'-04'\(bu\h'+03'\c
 567 .\}
 568 .el \{\
 569 .sp -1
 570 .IP \(bu 2.3
 571 .\}
 572 \fBgit-am\fR(1)
 573 to apply patches e\-mailed in from your contributors\&.
 574 .RE
 575 .sp
 576 .RS 4
 577 .ie n \{\
 578 \h'-04'\(bu\h'+03'\c
 579 .\}
 580 .el \{\
 581 .sp -1
 582 .IP \(bu 2.3
 583 .\}
 584 \fBgit-pull\fR(1)
 585 to merge from your trusted lieutenants\&.
 586 .RE
 587 .sp
 588 .RS 4
 589 .ie n \{\
 590 \h'-04'\(bu\h'+03'\c
 591 .\}
 592 .el \{\
 593 .sp -1
 594 .IP \(bu 2.3
 595 .\}
 596 \fBgit-format-patch\fR(1)
 597 to prepare and send suggested alternative to contributors\&.
 598 .RE
 599 .sp
 600 .RS 4
 601 .ie n \{\
 602 \h'-04'\(bu\h'+03'\c
 603 .\}
 604 .el \{\
 605 .sp -1
 606 .IP \(bu 2.3
 607 .\}
 608 \fBgit-revert\fR(1)
 609 to undo botched commits\&.
 610 .RE
 611 .sp
 612 .RS 4
 613 .ie n \{\
 614 \h'-04'\(bu\h'+03'\c
 615 .\}
 616 .el \{\
 617 .sp -1
 618 .IP \(bu 2.3
 619 .\}
 620 \fBgit-push\fR(1)
 621 to publish the bleeding edge\&.
 622 .RE
 623 .SS "Examples"
 624 .PP
 625 A typical integrator\(cqs Git day\&.
 626 .RS 4
 627 .sp
 628 .if n \{\
 629 .RS 4
 630 .\}
 631 .nf
 632 $ git status \fB(1)\fR
 633 $ git branch \-\-no\-merged master \fB(2)\fR
 634 $ mailx \fB(3)\fR
 635 & s 2 3 4 5 \&./+to\-apply
 636 & s 7 8 \&./+hold\-linus
 637 & q
 638 $ git switch \-c topic/one master
 639 $ git am \-3 \-i \-s \&./+to\-apply \fB(4)\fR
 640 $ compile/test
 641 $ git switch \-c hold/linus && git am \-3 \-i \-s \&./+hold\-linus \fB(5)\fR
 642 $ git switch topic/one && git rebase master \fB(6)\fR
 643 $ git switch \-C seen next \fB(7)\fR
 644 $ git merge topic/one topic/two && git merge hold/linus \fB(8)\fR
 645 $ git switch maint
 646 $ git cherry\-pick master~4 \fB(9)\fR
 647 $ compile/test
 648 $ git tag \-s \-m "GIT 0\&.99\&.9x" v0\&.99\&.9x \fB(10)\fR
 649 $ git fetch ko && for branch in master maint next seen \fB(11)\fR
 650     do
 651         git show\-branch ko/$branch $branch \fB(12)\fR
 652     done
 653 $ git push \-\-follow\-tags ko \fB(13)\fR
 654 .fi
 655 .if n \{\
 656 .RE
 657 .\}
 658 .TS
 659 tab(:);
 660 r lw(\n(.lu*75u/100u).
 661 \fB1.\fR\h'-2n':T{
 662 see what you were in the middle of doing, if anything\&.
 663 T}
 664 \fB2.\fR\h'-2n':T{
 665 see which branches haven\(cqt been merged into
 666 \fBmaster\fR
 667 yet\&. Likewise for any other integration branches e\&.g\&.
 668 \fBmaint\fR,
 669 \fBnext\fR
 670 and
 671 \fBseen\fR\&.
 672 T}
 673 \fB3.\fR\h'-2n':T{
 674 read mails, save ones that are applicable, and save others that are not quite ready (other mail readers are available)\&.
 675 T}
 676 \fB4.\fR\h'-2n':T{
 677 apply them, interactively, with your sign\-offs\&.
 678 T}
 679 \fB5.\fR\h'-2n':T{
 680 create topic branch as needed and apply, again with sign\-offs\&.
 681 T}
 682 \fB6.\fR\h'-2n':T{
 683 rebase internal topic branch that has not been merged to the master or exposed as a part of a stable branch\&.
 684 T}
 685 \fB7.\fR\h'-2n':T{
 686 restart
 687 \fBseen\fR
 688 every time from the next\&.
 689 T}
 690 \fB8.\fR\h'-2n':T{
 691 and bundle topic branches still cooking\&.
 692 T}
 693 \fB9.\fR\h'-2n':T{
 694 backport a critical fix\&.
 695 T}
 696 \fB10.\fR\h'-2n':T{
 697 create a signed tag\&.
 698 T}
 699 \fB11.\fR\h'-2n':T{
 700 make sure master was not accidentally rewound beyond that already pushed out\&.
 701 T}
 702 \fB12.\fR\h'-2n':T{
 703 In the output from
 704 \fBgit show\-branch\fR,
 705 \fBmaster\fR
 706 should have everything
 707 \fBko/master\fR
 708 has, and
 709 \fBnext\fR
 710 should have everything
 711 \fBko/next\fR
 712 has, etc\&.
 713 T}
 714 \fB13.\fR\h'-2n':T{
 715 push out the bleeding edge, together with new tags that point into the pushed history\&.
 716 T}
 717 .TE
 718 .RE
 719 .sp
 720 In this example, the \fBko\fR shorthand points at the Git maintainer\(cqs repository at kernel\&.org, and looks like this:
 721 .sp
 722 .if n \{\
 723 .RS 4
 724 .\}
 725 .nf
 726 (in \&.git/config)
 727 [remote "ko"]
 728         url = kernel\&.org:/pub/scm/git/git\&.git
 729         fetch = refs/heads/*:refs/remotes/ko/*
 730         push = refs/heads/master
 731         push = refs/heads/next
 732         push = +refs/heads/seen
 733         push = refs/heads/maint
 734 .fi
 735 .if n \{\
 736 .RE
 737 .\}
 738 .SH "REPOSITORY ADMINISTRATION"
 739 .sp
 740 A repository administrator uses the following tools to set up and maintain access to the repository by developers\&.
 741 .sp
 742 .RS 4
 743 .ie n \{\
 744 \h'-04'\(bu\h'+03'\c
 745 .\}
 746 .el \{\
 747 .sp -1
 748 .IP \(bu 2.3
 749 .\}
 750 \fBgit-daemon\fR(1)
 751 to allow anonymous download from repository\&.
 752 .RE
 753 .sp
 754 .RS 4
 755 .ie n \{\
 756 \h'-04'\(bu\h'+03'\c
 757 .\}
 758 .el \{\
 759 .sp -1
 760 .IP \(bu 2.3
 761 .\}
 762 \fBgit-shell\fR(1)
 763 can be used as a
 764 \fIrestricted login shell\fR
 765 for shared central repository users\&.
 766 .RE
 767 .sp
 768 .RS 4
 769 .ie n \{\
 770 \h'-04'\(bu\h'+03'\c
 771 .\}
 772 .el \{\
 773 .sp -1
 774 .IP \(bu 2.3
 775 .\}
 776 \fBgit-http-backend\fR(1)
 777 provides a server side implementation of Git\-over\-HTTP ("Smart http") allowing both fetch and push services\&.
 778 .RE
 779 .sp
 780 .RS 4
 781 .ie n \{\
 782 \h'-04'\(bu\h'+03'\c
 783 .\}
 784 .el \{\
 785 .sp -1
 786 .IP \(bu 2.3
 787 .\}
 788 \fBgitweb\fR(1)
 789 provides a web front\-end to Git repositories, which can be set\-up using the
 790 \fBgit-instaweb\fR(1)
 791 script\&.
 792 .RE
 793 .sp
 794 \m[blue]\fBupdate hook howto\fR\m[]\&\s-2\u[1]\d\s+2 has a good example of managing a shared central repository\&.
 795 .sp
 796 In addition there are a number of other widely deployed hosting, browsing and reviewing solutions such as:
 797 .sp
 798 .RS 4
 799 .ie n \{\
 800 \h'-04'\(bu\h'+03'\c
 801 .\}
 802 .el \{\
 803 .sp -1
 804 .IP \(bu 2.3
 805 .\}
 806 gitolite, gerrit code review, cgit and others\&.
 807 .RE
 808 .SS "Examples"
 809 .PP
 810 We assume the following in /etc/services
 811 .RS 4
 812 .sp
 813 .if n \{\
 814 .RS 4
 815 .\}
 816 .nf
 817 $ grep 9418 /etc/services
 818 git             9418/tcp                # Git Version Control System
 819 .fi
 820 .if n \{\
 821 .RE
 822 .\}
 823 .RE
 824 .PP
 825 Run git\-daemon to serve /pub/scm from inetd\&.
 826 .RS 4
 827 .sp
 828 .if n \{\
 829 .RS 4
 830 .\}
 831 .nf
 832 $ grep git /etc/inetd\&.conf
 833 git     stream  tcp     nowait  nobody \e
 834   /usr/bin/git\-daemon git\-daemon \-\-inetd \-\-export\-all /pub/scm
 835 .fi
 836 .if n \{\
 837 .RE
 838 .\}
 839 .sp
 840 The actual configuration line should be on one line\&.
 841 .RE
 842 .PP
 843 Run git\-daemon to serve /pub/scm from xinetd\&.
 844 .RS 4
 845 .sp
 846 .if n \{\
 847 .RS 4
 848 .\}
 849 .nf
 850 $ cat /etc/xinetd\&.d/git\-daemon
 851 # default: off
 852 # description: The Git server offers access to Git repositories
 853 service git
 854 {
 855         disable = no
 856         type            = UNLISTED
 857         port            = 9418
 858         socket_type     = stream
 859         wait            = no
 860         user            = nobody
 861         server          = /usr/bin/git\-daemon
 862         server_args     = \-\-inetd \-\-export\-all \-\-base\-path=/pub/scm
 863         log_on_failure  += USERID
 864 }
 865 .fi
 866 .if n \{\
 867 .RE
 868 .\}
 869 .sp
 870 Check your xinetd(8) documentation and setup, this is from a Fedora system\&. Others might be different\&.
 871 .RE
 872 .PP
 873 Give push/pull only access to developers using git\-over\-ssh\&.
 874 .RS 4
 875 e\&.g\&. those using:
 876 \fB$ git push/pull ssh://host\&.xz/pub/scm/project\fR
 877 .sp
 878 .if n \{\
 879 .RS 4
 880 .\}
 881 .nf
 882 $ grep git /etc/passwd \fB(1)\fR
 883 alice:x:1000:1000::/home/alice:/usr/bin/git\-shell
 884 bob:x:1001:1001::/home/bob:/usr/bin/git\-shell
 885 cindy:x:1002:1002::/home/cindy:/usr/bin/git\-shell
 886 david:x:1003:1003::/home/david:/usr/bin/git\-shell
 887 $ grep git /etc/shells \fB(2)\fR
 888 /usr/bin/git\-shell
 889 .fi
 890 .if n \{\
 891 .RE
 892 .\}
 893 .TS
 894 tab(:);
 895 r lw(\n(.lu*75u/100u).
 896 \fB1.\fR\h'-2n':T{
 897 log\-in shell is set to /usr/bin/git\-shell, which does not allow anything but
 898 \fBgit push\fR
 899 and
 900 \fBgit pull\fR\&. The users require ssh access to the machine\&.
 901 T}
 902 \fB2.\fR\h'-2n':T{
 903 in many distributions /etc/shells needs to list what is used as the login shell\&.
 904 T}
 905 .TE
 906 .RE
 907 .PP
 908 CVS\-style shared repository\&.
 909 .RS 4
 910 .sp
 911 .if n \{\
 912 .RS 4
 913 .\}
 914 .nf
 915 $ grep git /etc/group \fB(1)\fR
 916 git:x:9418:alice,bob,cindy,david
 917 $ cd /home/devo\&.git
 918 $ ls \-l \fB(2)\fR
 919   lrwxrwxrwx   1 david git    17 Dec  4 22:40 HEAD \-> refs/heads/master
 920   drwxrwsr\-x   2 david git  4096 Dec  4 22:40 branches
 921   \-rw\-rw\-r\-\-   1 david git    84 Dec  4 22:40 config
 922   \-rw\-rw\-r\-\-   1 david git    58 Dec  4 22:40 description
 923   drwxrwsr\-x   2 david git  4096 Dec  4 22:40 hooks
 924   \-rw\-rw\-r\-\-   1 david git 37504 Dec  4 22:40 index
 925   drwxrwsr\-x   2 david git  4096 Dec  4 22:40 info
 926   drwxrwsr\-x   4 david git  4096 Dec  4 22:40 objects
 927   drwxrwsr\-x   4 david git  4096 Nov  7 14:58 refs
 928   drwxrwsr\-x   2 david git  4096 Dec  4 22:40 remotes
 929 $ ls \-l hooks/update \fB(3)\fR
 930   \-r\-xr\-xr\-x   1 david git  3536 Dec  4 22:40 update
 931 $ cat info/allowed\-users \fB(4)\fR
 932 refs/heads/master       alice\e|cindy
 933 refs/heads/doc\-update   bob
 934 refs/tags/v[0\-9]*       david
 935 .fi
 936 .if n \{\
 937 .RE
 938 .\}
 939 .TS
 940 tab(:);
 941 r lw(\n(.lu*75u/100u).
 942 \fB1.\fR\h'-2n':T{
 943 place the developers into the same git group\&.
 944 T}
 945 \fB2.\fR\h'-2n':T{
 946 and make the shared repository writable by the group\&.
 947 T}
 948 \fB3.\fR\h'-2n':T{
 949 use update\-hook example by Carl from Documentation/howto/ for branch policy control\&.
 950 T}
 951 \fB4.\fR\h'-2n':T{
 952 alice and cindy can push into master, only bob can push into doc\-update\&. david is the release manager and is the only person who can create and push version tags\&.
 953 T}
 954 .TE
 955 .RE
 956 .SH "GIT"
 957 .sp
 958 Part of the \fBgit\fR(1) suite
 959 .SH "NOTES"
 960 .IP " 1." 4
 961 update hook howto
 962 .RS 4
 963 \%git-htmldocs/howto/update-hook-example.html
 964 .RE