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 vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2023-09-13
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.42.0.176.gd6c51973e4
   8 .\"  Language: English
   9 .\"
  10 .TH "GITEVERYDAY" "7" "2023\-09\-13" "Git 2\&.42\&.0\&.176\&.gd6c519" "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 command 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 .sp
 235 .TS
 236 tab(:);
 237 r lw(\n(.lu*75u/100u).
 238 \fB1.\fR\h'-2n':T{
 239 add everything under the current directory\&.
 240 T}
 241 \fB2.\fR\h'-2n':T{
 242 make a lightweight, unannotated tag\&.
 243 T}
 244 .TE
 245 .RE
 246 .PP
 247 Create a topic branch and develop\&.
 248 .RS 4
 249 .sp
 250 .if n \{\
 251 .RS 4
 252 .\}
 253 .nf
 254 $ git switch \-c alsa\-audio \fB(1)\fR
 255 $ edit/compile/test
 256 $ git restore curses/ux_audio_oss\&.c \fB(2)\fR
 257 $ git add curses/ux_audio_alsa\&.c \fB(3)\fR
 258 $ edit/compile/test
 259 $ git diff HEAD \fB(4)\fR
 260 $ git commit \-a \-s \fB(5)\fR
 261 $ edit/compile/test
 262 $ git diff HEAD^ \fB(6)\fR
 263 $ git commit \-a \-\-amend \fB(7)\fR
 264 $ git switch master \fB(8)\fR
 265 $ git merge alsa\-audio \fB(9)\fR
 266 $ git log \-\-since=\*(Aq3 days ago\*(Aq \fB(10)\fR
 267 $ git log v2\&.43\&.\&. curses/ \fB(11)\fR
 268 .fi
 269 .if n \{\
 270 .RE
 271 .\}
 272 .sp
 273 .TS
 274 tab(:);
 275 r lw(\n(.lu*75u/100u).
 276 \fB1.\fR\h'-2n':T{
 277 create a new topic branch\&.
 278 T}
 279 \fB2.\fR\h'-2n':T{
 280 revert your botched changes in
 281 \fBcurses/ux_audio_oss\&.c\fR\&.
 282 T}
 283 \fB3.\fR\h'-2n':T{
 284 you need to tell Git if you added a new file; removal and modification will be caught if you do
 285 \fBgit commit \-a\fR
 286 later\&.
 287 T}
 288 \fB4.\fR\h'-2n':T{
 289 to see what changes you are committing\&.
 290 T}
 291 \fB5.\fR\h'-2n':T{
 292 commit everything, as you have tested, with your sign\-off\&.
 293 T}
 294 \fB6.\fR\h'-2n':T{
 295 look at all your changes including the previous commit\&.
 296 T}
 297 \fB7.\fR\h'-2n':T{
 298 amend the previous commit, adding all your new changes, using your original message\&.
 299 T}
 300 \fB8.\fR\h'-2n':T{
 301 switch to the master branch\&.
 302 T}
 303 \fB9.\fR\h'-2n':T{
 304 merge a topic branch into your master branch\&.
 305 T}
 306 \fB10.\fR\h'-2n':T{
 307 review commit logs; other forms to limit output can be combined and include
 308 \fB\-10\fR
 309 (to show up to 10 commits),
 310 \fB\-\-until=2005\-12\-10\fR, etc\&.
 311 T}
 312 \fB11.\fR\h'-2n':T{
 313 view only the changes that touch what\(cqs in
 314 \fBcurses/\fR
 315 directory, since
 316 \fBv2\&.43\fR
 317 tag\&.
 318 T}
 319 .TE
 320 .RE
 321 .SH "INDIVIDUAL DEVELOPER (PARTICIPANT)"
 322 .sp
 323 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\&.
 324 .sp
 325 .RS 4
 326 .ie n \{\
 327 \h'-04'\(bu\h'+03'\c
 328 .\}
 329 .el \{\
 330 .sp -1
 331 .IP \(bu 2.3
 332 .\}
 333 \fBgit-clone\fR(1)
 334 from the upstream to prime your local repository\&.
 335 .RE
 336 .sp
 337 .RS 4
 338 .ie n \{\
 339 \h'-04'\(bu\h'+03'\c
 340 .\}
 341 .el \{\
 342 .sp -1
 343 .IP \(bu 2.3
 344 .\}
 345 \fBgit-pull\fR(1)
 346 and
 347 \fBgit-fetch\fR(1)
 348 from "origin" to keep up\-to\-date with the upstream\&.
 349 .RE
 350 .sp
 351 .RS 4
 352 .ie n \{\
 353 \h'-04'\(bu\h'+03'\c
 354 .\}
 355 .el \{\
 356 .sp -1
 357 .IP \(bu 2.3
 358 .\}
 359 \fBgit-push\fR(1)
 360 to shared repository, if you adopt CVS style shared repository workflow\&.
 361 .RE
 362 .sp
 363 .RS 4
 364 .ie n \{\
 365 \h'-04'\(bu\h'+03'\c
 366 .\}
 367 .el \{\
 368 .sp -1
 369 .IP \(bu 2.3
 370 .\}
 371 \fBgit-format-patch\fR(1)
 372 to prepare e\-mail submission, if you adopt Linux kernel\-style public forum workflow\&.
 373 .RE
 374 .sp
 375 .RS 4
 376 .ie n \{\
 377 \h'-04'\(bu\h'+03'\c
 378 .\}
 379 .el \{\
 380 .sp -1
 381 .IP \(bu 2.3
 382 .\}
 383 \fBgit-send-email\fR(1)
 384 to send your e\-mail submission without corruption by your MUA\&.
 385 .RE
 386 .sp
 387 .RS 4
 388 .ie n \{\
 389 \h'-04'\(bu\h'+03'\c
 390 .\}
 391 .el \{\
 392 .sp -1
 393 .IP \(bu 2.3
 394 .\}
 395 \fBgit-request-pull\fR(1)
 396 to create a summary of changes for your upstream to pull\&.
 397 .RE
 398 .SS "Examples"
 399 .PP
 400 Clone the upstream and work on it\&. Feed changes to upstream\&.
 401 .RS 4
 402 .sp
 403 .if n \{\
 404 .RS 4
 405 .\}
 406 .nf
 407 $ git clone git://git\&.kernel\&.org/pub/scm/\&.\&.\&./torvalds/linux\-2\&.6 my2\&.6
 408 $ cd my2\&.6
 409 $ git switch \-c mine master \fB(1)\fR
 410 $ edit/compile/test; git commit \-a \-s \fB(2)\fR
 411 $ git format\-patch master \fB(3)\fR
 412 $ git send\-email \-\-to="person <email@example\&.com>" 00*\&.patch \fB(4)\fR
 413 $ git switch master \fB(5)\fR
 414 $ git pull \fB(6)\fR
 415 $ git log \-p ORIG_HEAD\&.\&. arch/i386 include/asm\-i386 \fB(7)\fR
 416 $ git ls\-remote \-\-heads http://git\&.kernel\&.org/\&.\&.\&./jgarzik/libata\-dev\&.git \fB(8)\fR
 417 $ git pull git://git\&.kernel\&.org/pub/\&.\&.\&./jgarzik/libata\-dev\&.git ALL \fB(9)\fR
 418 $ git reset \-\-hard ORIG_HEAD \fB(10)\fR
 419 $ git gc \fB(11)\fR
 420 .fi
 421 .if n \{\
 422 .RE
 423 .\}
 424 .sp
 425 .TS
 426 tab(:);
 427 r lw(\n(.lu*75u/100u).
 428 \fB1.\fR\h'-2n':T{
 429 checkout a new branch
 430 \fBmine\fR
 431 from master\&.
 432 T}
 433 \fB2.\fR\h'-2n':T{
 434 repeat as needed\&.
 435 T}
 436 \fB3.\fR\h'-2n':T{
 437 extract patches from your branch, relative to master,
 438 T}
 439 \fB4.\fR\h'-2n':T{
 440 and email them\&.
 441 T}
 442 \fB5.\fR\h'-2n':T{
 443 return to
 444 \fBmaster\fR, ready to see what\(cqs new
 445 T}
 446 \fB6.\fR\h'-2n':T{
 447 \fBgit pull\fR
 448 fetches from
 449 \fBorigin\fR
 450 by default and merges into the current branch\&.
 451 T}
 452 \fB7.\fR\h'-2n':T{
 453 immediately after pulling, look at the changes done upstream since last time we checked, only in the area we are interested in\&.
 454 T}
 455 \fB8.\fR\h'-2n':T{
 456 check the branch names in an external repository (if not known)\&.
 457 T}
 458 \fB9.\fR\h'-2n':T{
 459 fetch from a specific branch
 460 \fBALL\fR
 461 from a specific repository and merge it\&.
 462 T}
 463 \fB10.\fR\h'-2n':T{
 464 revert the pull\&.
 465 T}
 466 \fB11.\fR\h'-2n':T{
 467 garbage collect leftover objects from reverted pull\&.
 468 T}
 469 .TE
 470 .RE
 471 .PP
 472 Push into another repository\&.
 473 .RS 4
 474 .sp
 475 .if n \{\
 476 .RS 4
 477 .\}
 478 .nf
 479 satellite$ git clone mothership:frotz frotz \fB(1)\fR
 480 satellite$ cd frotz
 481 satellite$ git config \-\-get\-regexp \*(Aq^(remote|branch)\e\&.\*(Aq \fB(2)\fR
 482 remote\&.origin\&.url mothership:frotz
 483 remote\&.origin\&.fetch refs/heads/*:refs/remotes/origin/*
 484 branch\&.master\&.remote origin
 485 branch\&.master\&.merge refs/heads/master
 486 satellite$ git config remote\&.origin\&.push \e
 487            +refs/heads/*:refs/remotes/satellite/* \fB(3)\fR
 488 satellite$ edit/compile/test/commit
 489 satellite$ git push origin \fB(4)\fR
 490
 491 mothership$ cd frotz
 492 mothership$ git switch master
 493 mothership$ git merge satellite/master \fB(5)\fR
 494 .fi
 495 .if n \{\
 496 .RE
 497 .\}
 498 .sp
 499 .TS
 500 tab(:);
 501 r lw(\n(.lu*75u/100u).
 502 \fB1.\fR\h'-2n':T{
 503 mothership machine has a frotz repository under your home directory; clone from it to start a repository on the satellite machine\&.
 504 T}
 505 \fB2.\fR\h'-2n':T{
 506 clone sets these configuration variables by default\&. It arranges
 507 \fBgit pull\fR
 508 to fetch and store the branches of mothership machine to local
 509 \fBremotes/origin/*\fR
 510 remote\-tracking branches\&.
 511 T}
 512 \fB3.\fR\h'-2n':T{
 513 arrange
 514 \fBgit push\fR
 515 to push all local branches to their corresponding branch of the mothership machine\&.
 516 T}
 517 \fB4.\fR\h'-2n':T{
 518 push will stash all our work away on
 519 \fBremotes/satellite/*\fR
 520 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)\&.
 521 T}
 522 \fB5.\fR\h'-2n':T{
 523 on mothership machine, merge the work done on the satellite machine into the master branch\&.
 524 T}
 525 .TE
 526 .RE
 527 .PP
 528 Branch off of a specific tag\&.
 529 .RS 4
 530 .sp
 531 .if n \{\
 532 .RS 4
 533 .\}
 534 .nf
 535 $ git switch \-c private2\&.6\&.14 v2\&.6\&.14 \fB(1)\fR
 536 $ edit/compile/test; git commit \-a
 537 $ git checkout master
 538 $ git cherry\-pick v2\&.6\&.14\&.\&.private2\&.6\&.14 \fB(2)\fR
 539 .fi
 540 .if n \{\
 541 .RE
 542 .\}
 543 .sp
 544 .TS
 545 tab(:);
 546 r lw(\n(.lu*75u/100u).
 547 \fB1.\fR\h'-2n':T{
 548 create a private branch based on a well known (but somewhat behind) tag\&.
 549 T}
 550 \fB2.\fR\h'-2n':T{
 551 forward port all changes in
 552 \fBprivate2\&.6\&.14\fR
 553 branch to
 554 \fBmaster\fR
 555 branch without a formal "merging"\&. Or longhand
 556
 557 \fBgit format\-patch \-k \-m \-\-stdout v2\&.6\&.14\&.\&.private2\&.6\&.14 | git am \-3 \-k\fR
 558 T}
 559 .TE
 560 .RE
 561 .sp
 562 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\&.
 563 .SH "INTEGRATOR"
 564 .sp
 565 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\&.
 566 .sp
 567 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\&.
 568 .sp
 569 .RS 4
 570 .ie n \{\
 571 \h'-04'\(bu\h'+03'\c
 572 .\}
 573 .el \{\
 574 .sp -1
 575 .IP \(bu 2.3
 576 .\}
 577 \fBgit-am\fR(1)
 578 to apply patches e\-mailed in from your contributors\&.
 579 .RE
 580 .sp
 581 .RS 4
 582 .ie n \{\
 583 \h'-04'\(bu\h'+03'\c
 584 .\}
 585 .el \{\
 586 .sp -1
 587 .IP \(bu 2.3
 588 .\}
 589 \fBgit-pull\fR(1)
 590 to merge from your trusted lieutenants\&.
 591 .RE
 592 .sp
 593 .RS 4
 594 .ie n \{\
 595 \h'-04'\(bu\h'+03'\c
 596 .\}
 597 .el \{\
 598 .sp -1
 599 .IP \(bu 2.3
 600 .\}
 601 \fBgit-format-patch\fR(1)
 602 to prepare and send suggested alternative to contributors\&.
 603 .RE
 604 .sp
 605 .RS 4
 606 .ie n \{\
 607 \h'-04'\(bu\h'+03'\c
 608 .\}
 609 .el \{\
 610 .sp -1
 611 .IP \(bu 2.3
 612 .\}
 613 \fBgit-revert\fR(1)
 614 to undo botched commits\&.
 615 .RE
 616 .sp
 617 .RS 4
 618 .ie n \{\
 619 \h'-04'\(bu\h'+03'\c
 620 .\}
 621 .el \{\
 622 .sp -1
 623 .IP \(bu 2.3
 624 .\}
 625 \fBgit-push\fR(1)
 626 to publish the bleeding edge\&.
 627 .RE
 628 .SS "Examples"
 629 .PP
 630 A typical integrator\(cqs Git day\&.
 631 .RS 4
 632 .sp
 633 .if n \{\
 634 .RS 4
 635 .\}
 636 .nf
 637 $ git status \fB(1)\fR
 638 $ git branch \-\-no\-merged master \fB(2)\fR
 639 $ mailx \fB(3)\fR
 640 & s 2 3 4 5 \&./+to\-apply
 641 & s 7 8 \&./+hold\-linus
 642 & q
 643 $ git switch \-c topic/one master
 644 $ git am \-3 \-i \-s \&./+to\-apply \fB(4)\fR
 645 $ compile/test
 646 $ git switch \-c hold/linus && git am \-3 \-i \-s \&./+hold\-linus \fB(5)\fR
 647 $ git switch topic/one && git rebase master \fB(6)\fR
 648 $ git switch \-C seen next \fB(7)\fR
 649 $ git merge topic/one topic/two && git merge hold/linus \fB(8)\fR
 650 $ git switch maint
 651 $ git cherry\-pick master~4 \fB(9)\fR
 652 $ compile/test
 653 $ git tag \-s \-m "GIT 0\&.99\&.9x" v0\&.99\&.9x \fB(10)\fR
 654 $ git fetch ko && for branch in master maint next seen \fB(11)\fR
 655     do
 656         git show\-branch ko/$branch $branch \fB(12)\fR
 657     done
 658 $ git push \-\-follow\-tags ko \fB(13)\fR
 659 .fi
 660 .if n \{\
 661 .RE
 662 .\}
 663 .sp
 664 .TS
 665 tab(:);
 666 r lw(\n(.lu*75u/100u).
 667 \fB1.\fR\h'-2n':T{
 668 see what you were in the middle of doing, if anything\&.
 669 T}
 670 \fB2.\fR\h'-2n':T{
 671 see which branches haven\(cqt been merged into
 672 \fBmaster\fR
 673 yet\&. Likewise for any other integration branches e\&.g\&.
 674 \fBmaint\fR,
 675 \fBnext\fR
 676 and
 677 \fBseen\fR\&.
 678 T}
 679 \fB3.\fR\h'-2n':T{
 680 read mails, save ones that are applicable, and save others that are not quite ready (other mail readers are available)\&.
 681 T}
 682 \fB4.\fR\h'-2n':T{
 683 apply them, interactively, with your sign\-offs\&.
 684 T}
 685 \fB5.\fR\h'-2n':T{
 686 create topic branch as needed and apply, again with sign\-offs\&.
 687 T}
 688 \fB6.\fR\h'-2n':T{
 689 rebase internal topic branch that has not been merged to the master or exposed as a part of a stable branch\&.
 690 T}
 691 \fB7.\fR\h'-2n':T{
 692 restart
 693 \fBseen\fR
 694 every time from the next\&.
 695 T}
 696 \fB8.\fR\h'-2n':T{
 697 and bundle topic branches still cooking\&.
 698 T}
 699 \fB9.\fR\h'-2n':T{
 700 backport a critical fix\&.
 701 T}
 702 \fB10.\fR\h'-2n':T{
 703 create a signed tag\&.
 704 T}
 705 \fB11.\fR\h'-2n':T{
 706 make sure master was not accidentally rewound beyond that already pushed out\&.
 707 T}
 708 \fB12.\fR\h'-2n':T{
 709 In the output from
 710 \fBgit show\-branch\fR,
 711 \fBmaster\fR
 712 should have everything
 713 \fBko/master\fR
 714 has, and
 715 \fBnext\fR
 716 should have everything
 717 \fBko/next\fR
 718 has, etc\&.
 719 T}
 720 \fB13.\fR\h'-2n':T{
 721 push out the bleeding edge, together with new tags that point into the pushed history\&.
 722 T}
 723 .TE
 724 .RE
 725 .sp
 726 In this example, the \fBko\fR shorthand points at the Git maintainer\(cqs repository at kernel\&.org, and looks like this:
 727 .sp
 728 .if n \{\
 729 .RS 4
 730 .\}
 731 .nf
 732 (in \&.git/config)
 733 [remote "ko"]
 734         url = kernel\&.org:/pub/scm/git/git\&.git
 735         fetch = refs/heads/*:refs/remotes/ko/*
 736         push = refs/heads/master
 737         push = refs/heads/next
 738         push = +refs/heads/seen
 739         push = refs/heads/maint
 740 .fi
 741 .if n \{\
 742 .RE
 743 .\}
 744 .sp
 745 .SH "REPOSITORY ADMINISTRATION"
 746 .sp
 747 A repository administrator uses the following tools to set up and maintain access to the repository by developers\&.
 748 .sp
 749 .RS 4
 750 .ie n \{\
 751 \h'-04'\(bu\h'+03'\c
 752 .\}
 753 .el \{\
 754 .sp -1
 755 .IP \(bu 2.3
 756 .\}
 757 \fBgit-daemon\fR(1)
 758 to allow anonymous download from repository\&.
 759 .RE
 760 .sp
 761 .RS 4
 762 .ie n \{\
 763 \h'-04'\(bu\h'+03'\c
 764 .\}
 765 .el \{\
 766 .sp -1
 767 .IP \(bu 2.3
 768 .\}
 769 \fBgit-shell\fR(1)
 770 can be used as a
 771 \fIrestricted login shell\fR
 772 for shared central repository users\&.
 773 .RE
 774 .sp
 775 .RS 4
 776 .ie n \{\
 777 \h'-04'\(bu\h'+03'\c
 778 .\}
 779 .el \{\
 780 .sp -1
 781 .IP \(bu 2.3
 782 .\}
 783 \fBgit-http-backend\fR(1)
 784 provides a server side implementation of Git\-over\-HTTP ("Smart http") allowing both fetch and push services\&.
 785 .RE
 786 .sp
 787 .RS 4
 788 .ie n \{\
 789 \h'-04'\(bu\h'+03'\c
 790 .\}
 791 .el \{\
 792 .sp -1
 793 .IP \(bu 2.3
 794 .\}
 795 \fBgitweb\fR(1)
 796 provides a web front\-end to Git repositories, which can be set\-up using the
 797 \fBgit-instaweb\fR(1)
 798 script\&.
 799 .RE
 800 .sp
 801 \m[blue]\fBupdate hook howto\fR\m[]\&\s-2\u[1]\d\s+2 has a good example of managing a shared central repository\&.
 802 .sp
 803 In addition there are a number of other widely deployed hosting, browsing and reviewing solutions such as:
 804 .sp
 805 .RS 4
 806 .ie n \{\
 807 \h'-04'\(bu\h'+03'\c
 808 .\}
 809 .el \{\
 810 .sp -1
 811 .IP \(bu 2.3
 812 .\}
 813 gitolite, gerrit code review, cgit and others\&.
 814 .RE
 815 .SS "Examples"
 816 .PP
 817 We assume the following in /etc/services
 818 .RS 4
 819 .sp
 820 .if n \{\
 821 .RS 4
 822 .\}
 823 .nf
 824 $ grep 9418 /etc/services
 825 git             9418/tcp                # Git Version Control System
 826 .fi
 827 .if n \{\
 828 .RE
 829 .\}
 830 .sp
 831 .RE
 832 .PP
 833 Run git\-daemon to serve /pub/scm from inetd\&.
 834 .RS 4
 835 .sp
 836 .if n \{\
 837 .RS 4
 838 .\}
 839 .nf
 840 $ grep git /etc/inetd\&.conf
 841 git     stream  tcp     nowait  nobody \e
 842   /usr/bin/git\-daemon git\-daemon \-\-inetd \-\-export\-all /pub/scm
 843 .fi
 844 .if n \{\
 845 .RE
 846 .\}
 847 .sp
 848 The actual configuration line should be on one line\&.
 849 .RE
 850 .PP
 851 Run git\-daemon to serve /pub/scm from xinetd\&.
 852 .RS 4
 853 .sp
 854 .if n \{\
 855 .RS 4
 856 .\}
 857 .nf
 858 $ cat /etc/xinetd\&.d/git\-daemon
 859 # default: off
 860 # description: The Git server offers access to Git repositories
 861 service git
 862 {
 863         disable = no
 864         type            = UNLISTED
 865         port            = 9418
 866         socket_type     = stream
 867         wait            = no
 868         user            = nobody
 869         server          = /usr/bin/git\-daemon
 870         server_args     = \-\-inetd \-\-export\-all \-\-base\-path=/pub/scm
 871         log_on_failure  += USERID
 872 }
 873 .fi
 874 .if n \{\
 875 .RE
 876 .\}
 877 .sp
 878 Check your xinetd(8) documentation and setup, this is from a Fedora system\&. Others might be different\&.
 879 .RE
 880 .PP
 881 Give push/pull only access to developers using git\-over\-ssh\&.
 882 .RS 4
 883 e\&.g\&. those using:
 884 \fB$ git push/pull ssh://host\&.xz/pub/scm/project\fR
 885 .sp
 886 .if n \{\
 887 .RS 4
 888 .\}
 889 .nf
 890 $ grep git /etc/passwd \fB(1)\fR
 891 alice:x:1000:1000::/home/alice:/usr/bin/git\-shell
 892 bob:x:1001:1001::/home/bob:/usr/bin/git\-shell
 893 cindy:x:1002:1002::/home/cindy:/usr/bin/git\-shell
 894 david:x:1003:1003::/home/david:/usr/bin/git\-shell
 895 $ grep git /etc/shells \fB(2)\fR
 896 /usr/bin/git\-shell
 897 .fi
 898 .if n \{\
 899 .RE
 900 .\}
 901 .sp
 902 .TS
 903 tab(:);
 904 r lw(\n(.lu*75u/100u).
 905 \fB1.\fR\h'-2n':T{
 906 log\-in shell is set to /usr/bin/git\-shell, which does not allow anything but
 907 \fBgit push\fR
 908 and
 909 \fBgit pull\fR\&. The users require ssh access to the machine\&.
 910 T}
 911 \fB2.\fR\h'-2n':T{
 912 in many distributions /etc/shells needs to list what is used as the login shell\&.
 913 T}
 914 .TE
 915 .RE
 916 .PP
 917 CVS\-style shared repository\&.
 918 .RS 4
 919 .sp
 920 .if n \{\
 921 .RS 4
 922 .\}
 923 .nf
 924 $ grep git /etc/group \fB(1)\fR
 925 git:x:9418:alice,bob,cindy,david
 926 $ cd /home/devo\&.git
 927 $ ls \-l \fB(2)\fR
 928   lrwxrwxrwx   1 david git    17 Dec  4 22:40 HEAD \-> refs/heads/master
 929   drwxrwsr\-x   2 david git  4096 Dec  4 22:40 branches
 930   \-rw\-rw\-r\-\-   1 david git    84 Dec  4 22:40 config
 931   \-rw\-rw\-r\-\-   1 david git    58 Dec  4 22:40 description
 932   drwxrwsr\-x   2 david git  4096 Dec  4 22:40 hooks
 933   \-rw\-rw\-r\-\-   1 david git 37504 Dec  4 22:40 index
 934   drwxrwsr\-x   2 david git  4096 Dec  4 22:40 info
 935   drwxrwsr\-x   4 david git  4096 Dec  4 22:40 objects
 936   drwxrwsr\-x   4 david git  4096 Nov  7 14:58 refs
 937   drwxrwsr\-x   2 david git  4096 Dec  4 22:40 remotes
 938 $ ls \-l hooks/update \fB(3)\fR
 939   \-r\-xr\-xr\-x   1 david git  3536 Dec  4 22:40 update
 940 $ cat info/allowed\-users \fB(4)\fR
 941 refs/heads/master       alice\e|cindy
 942 refs/heads/doc\-update   bob
 943 refs/tags/v[0\-9]*       david
 944 .fi
 945 .if n \{\
 946 .RE
 947 .\}
 948 .sp
 949 .TS
 950 tab(:);
 951 r lw(\n(.lu*75u/100u).
 952 \fB1.\fR\h'-2n':T{
 953 place the developers into the same git group\&.
 954 T}
 955 \fB2.\fR\h'-2n':T{
 956 and make the shared repository writable by the group\&.
 957 T}
 958 \fB3.\fR\h'-2n':T{
 959 use update\-hook example by Carl from Documentation/howto/ for branch policy control\&.
 960 T}
 961 \fB4.\fR\h'-2n':T{
 962 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\&.
 963 T}
 964 .TE
 965 .RE
 966 .SH "GIT"
 967 .sp
 968 Part of the \fBgit\fR(1) suite
 969 .SH "NOTES"
 970 .IP " 1." 4
 971 update hook howto
 972 .RS 4
 973 \%git-htmldocs/howto/update-hook-example.html
 974 .RE