diff options
| -rw-r--r-- | site/git/index.php | 160 |
1 files changed, 80 insertions, 80 deletions
diff --git a/site/git/index.php b/site/git/index.php index 4b32166..63c4c6c 100644 --- a/site/git/index.php +++ b/site/git/index.php @@ -59,38 +59,11 @@ <a href="<?php echo $lbWebsiteGitwebAddress; ?>">Browse repository via web</a> </p> - <h2 id="contrib"><?php echo gettext("Submitting patches"); ?></h2> - <p> - <?php echo gettext("The <a href=\"http://git-scm.com/doc\">git documentation</a> describes how to use git. The following notes include simple tips for how to use git, but it is a good idea to get fully acquainted with git."); ?> - </p> - <p> - <?php echo gettext("Make sure that you configured git so that your name and email address appear in the commits that you create:"); ?><br/> - $ <b>git config --global user.name "Your Name"</b><br/> - $ <b>git config --global user.email your@emailaddress.com</b><br/> - <b>NOTE: you don't have to use your legal name. We don't care what name you use.</b> - </p> - <p> - <?php echo gettext("The following is also useful:"); ?><br/> - $ <b>git config --global core.editor nano</b><br/> - $ <b>git config --global color.status auto</b><br/> - $ <b>git config --global color.branch auto</b><br/> - $ <b>git config --global color.interactive auto</b><br/> - $ <b>git config --global color.diff auto</b> - </p> - <p> - <?php echo gettext("Clone the git repository, and make your desired changes."); ?> - <?php echo gettext("You can make one or several commits (as many as you like)."); ?> - <?php echo gettext("Generally speaking, you should create separate commits on top of each other, for each kind of change."); ?> - </p> - <p> - <?php echo gettext("Once you have made your change(s), you can use this to check the status:"); ?><br/> - $ <b>git status</b> - </p> </div> <div> - <h2>General guidelines</h2> + <h2>General guidelines for submitting patches</h2> <p> <?php echo gettext("Using your legal name is not required. For reasons why we have this policy, read <a href='http://geekfeminism.org/2012/09/29/quick-hit-how-git-shows-the-patriarchal-nature-of-the-software-industry/'>this article</a>. You can use an alias, or your company name (if you have a company), if you want. Also, read <a href='http://www.kalzumeus.com/2010/06/17/falsehoods-programmers-believe-about-names/'>this article</a>."); ?> </p> @@ -111,68 +84,95 @@ </div> <div> - - <p> - <?php echo gettext("The status command will show any untracked files that you have. Add them using <b>git add path/to/file</b>. You should also add any other files that are listed as modified in the git status. If there are deleted files in the git status, you can use <b>git rm path/to/file</b>. As long as you have added all the untracked files, it is generally easier to use:"); ?><br/> - $ <b>git commit -a</b><br/> - <?php echo gettext("(instead of <b>git commit</b>)"); ?> - </p> - <p> - <?php echo gettext("If you need to make a change to the current commit, you can do so with:"); ?><br/> - $ <b>git commit --amend</b><br/> - <?php echo gettext("or:"); ?><br/> - $ <b>git commit -a --amend</b> - </p> - <p> - <?php echo gettext("In your local git tree, you can use this to check your commits:"); ?><br/> - $ <b>git log</b> - </p> - <p> - <?php echo gettext("Shortened git logs showing the short commit ID and the commit title, plus info about what branch you are on, and where all your remotes/heads are:"); ?><br/> - $ <b>git config --global --add alias.lol "log --graph --decorate --pretty=oneline --abbrev-commit --all"</b><br/> - <?php echo gettext("From then on, you can use:"); ?><br/> - $ <b>git lol</b><br/> - <?php echo gettext("This is like <b>git log</b>, but it's much better and shows branches, etc."); ?> - </p> - <h3><?php echo gettext("Method 1: host a repository"); ?></h3> + <h2 id="contrib"><?php echo gettext("Submitting patches"); ?></h2> <p> - <?php echo gettext("Give the checkout details to the libreboot project, along with information on which commits in what branch contain your changes."); ?> + <?php echo gettext("The <a href=\"http://git-scm.com/doc\">git documentation</a> describes how to use git. The following notes include simple tips for how to use git, but it is a good idea to get fully acquainted with git."); ?> </p> - <h3><?php echo gettext("Method 2: git format-patch -N"); ?></h3> <p> - <?php echo gettext("Use this method (replace N with the number of commits that you made) and send the .patch files to the libreboot project, along with details on what branch and revision these were made on top of."); ?> + <?php echo gettext("Make sure that you configured git so that your name and email address appear in the commits that you create:"); ?><br/> + $ <b>git config --global user.name "Your Name"</b><br/> + $ <b>git config --global user.email your@emailaddress.com</b><br/> + <b>NOTE: you don't have to use your legal name. We don't care what name you use.</b> </p> - <p> - <?php echo gettext("Contact the libreboot project using the details on the home page, sending your patch(es). The mailing list is generally preferable, although IRC can also be just as good for small patches (you would probably put the patch on a paste site)."); ?> - </p> - - <h2 id="gitbackup"><?php echo gettext("Backup repositories"); ?></h2> - - <h3><?php echo gettext("Firmware (coreboot distribution)"); ?></h3> <p> -<?php - for ($server=0; $server<count($lbFirmwareBackupGitRepoAddress); $server++) { -?> - $ <b>git clone <?php echo $lbFirmwareBackupGitRepoAddress[$server]; ?></b> - <?php if ($server!=count($lbFirmwareBackupGitRepoAddress)-1) echo "<br/>"; ?> -<?php - } -?> + <?php echo gettext("The following is also useful:"); ?><br/> + $ <b>git config --global core.editor nano</b><br/> + $ <b>git config --global color.status auto</b><br/> + $ <b>git config --global color.branch auto</b><br/> + $ <b>git config --global color.interactive auto</b><br/> + $ <b>git config --global color.diff auto</b> + </p> + <p> + <?php echo gettext("Clone the git repository, and make your desired changes."); ?> + <?php echo gettext("You can make one or several commits (as many as you like)."); ?> + <?php echo gettext("Generally speaking, you should create separate commits on top of each other, for each kind of change."); ?> + </p> + <p> + <?php echo gettext("Once you have made your change(s), you can use this to check the status:"); ?><br/> + $ <b>git status</b> </p> - <h3><?php echo gettext("Libreboot website"); ?></h3> <p> -<?php - for ($server=0; $server<count($lbWebsiteBackupGitRepoAddress); $server++) { -?> - $ <b>git clone <?php echo $lbWebsiteBackupGitRepoAddress[$server]; ?></b> - <?php if ($server!=count($lbWebsiteBackupGitRepoAddress)-1) echo "<br/>"; ?> -<?php - } -?> + <?php echo gettext("The status command will show any untracked files that you have. Add them using <b>git add path/to/file</b>. You should also add any other files that are listed as modified in the git status. If there are deleted files in the git status, you can use <b>git rm path/to/file</b>. As long as you have added all the untracked files, it is generally easier to use:"); ?><br/> + $ <b>git commit -a</b><br/> + <?php echo gettext("(instead of <b>git commit</b>)"); ?> + </p> + <p> + <?php echo gettext("If you need to make a change to the current commit, you can do so with:"); ?><br/> + $ <b>git commit --amend</b><br/> + <?php echo gettext("or:"); ?><br/> + $ <b>git commit -a --amend</b> + </p> + <p> + <?php echo gettext("In your local git tree, you can use this to check your commits:"); ?><br/> + $ <b>git log</b> + </p> + <p> + <?php echo gettext("Shortened git logs showing the short commit ID and the commit title, plus info about what branch you are on, and where all your remotes/heads are:"); ?><br/> + $ <b>git config --global --add alias.lol "log --graph --decorate --pretty=oneline --abbrev-commit --all"</b><br/> + <?php echo gettext("From then on, you can use:"); ?><br/> + $ <b>git lol</b><br/> + <?php echo gettext("This is like <b>git log</b>, but it's much better and shows branches, etc."); ?> + </p> + <h3><?php echo gettext("Method 1: host a repository"); ?></h3> + <p> + <?php echo gettext("Give the checkout details to the libreboot project, along with information on which commits in what branch contain your changes."); ?> + </p> + <h3><?php echo gettext("Method 2: git format-patch -N"); ?></h3> + <p> + <?php echo gettext("Use this method (replace N with the number of commits that you made) and send the .patch files to the libreboot project, along with details on what branch and revision these were made on top of."); ?> + </p> + <p> + <?php echo gettext("Contact the libreboot project using the details on the home page, sending your patch(es). The mailing list is generally preferable, although IRC can also be just as good for small patches (you would probably put the patch on a paste site)."); ?> </p> - <p><a href="../"><?php echo gettext("Back to home page"); ?></a></p> + <h2 id="gitbackup"><?php echo gettext("Backup repositories"); ?></h2> + + <h3><?php echo gettext("Firmware (coreboot distribution)"); ?></h3> + <p> + <?php + for ($server=0; $server<count($lbFirmwareBackupGitRepoAddress); $server++) { + ?> + $ <b>git clone <?php echo $lbFirmwareBackupGitRepoAddress[$server]; ?></b> + <?php if ($server!=count($lbFirmwareBackupGitRepoAddress)-1) echo "<br/>"; ?> + <?php + } + ?> + </p> + + <h3><?php echo gettext("Libreboot website"); ?></h3> + <p> + <?php + for ($server=0; $server<count($lbWebsiteBackupGitRepoAddress); $server++) { + ?> + $ <b>git clone <?php echo $lbWebsiteBackupGitRepoAddress[$server]; ?></b> + <?php if ($server!=count($lbWebsiteBackupGitRepoAddress)-1) echo "<br/>"; ?> + <?php + } + ?> + </p> + + <p><a href="../"><?php echo gettext("Back to home page"); ?></a></p> </div> |