diff options
Diffstat (limited to 'site/git')
| -rw-r--r-- | site/git/index.php | 92 |
1 files changed, 46 insertions, 46 deletions
diff --git a/site/git/index.php b/site/git/index.php index 8b1a83c..34c1e9e 100644 --- a/site/git/index.php +++ b/site/git/index.php @@ -64,15 +64,15 @@ (such as coreboot) require a legal name, and this can be problematic for certain groups of people. </p> <p> - Using your legal name is <b>not</b> required when submitting patches to libreboot. 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 a pseudonym (alternative name), or your company name (if you have one), if you want or need to do that. You can also - submit patches <i>without a name</i>, if you want or need to do that (instructions are provided on this page). Also, read <a href='http://www.kalzumeus.com/2010/06/17/falsehoods-programmers-believe-about-names/'>this article</a>. Unfortunately, git appears to be stuck with these problems, when an author changes their name, and we don't have a concrete answer to it. + Using your legal name is <strong>not</strong> required when submitting patches to libreboot. 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 a pseudonym (alternative name), or your company name (if you have one), if you want or need to do that. You can also + submit patches <em>without a name</em>, if you want or need to do that (instructions are provided on this page). Also, read <a href='http://www.kalzumeus.com/2010/06/17/falsehoods-programmers-believe-about-names/'>this article</a>. Unfortunately, git appears to be stuck with these problems, when an author changes their name, and we don't have a concrete answer to it. As far as we know, publishing your legal name isn't even required for copyright purposes; in fact, "pen" names are commonly used by literary authors. </p> <p> - When submitting any kind of documentation, try not to use the terms him/her, she/he, his/her, or anything that is gender biased. <b>Use their, they, them, those people, that person, and so on.</b> <a href="https://gist.githubusercontent.com/0xabad1dea/8870b192fd1758743f66/raw/a230fa3438ce60c538dba31830fa88143245b719/singularthey.md">You are making a huge difference</a>. + When submitting any kind of documentation, try not to use the terms him/her, she/he, his/her, or anything that is gender biased. <strong>Use their, they, them, those people, that person, and so on.</strong> <a href="https://gist.githubusercontent.com/0xabad1dea/8870b192fd1758743f66/raw/a230fa3438ce60c538dba31830fa88143245b719/singularthey.md">You are making a huge difference</a>. </p> <p> - If you're worried about receiving spam, you can supply patches with a non-existent email address; see notes below about <i>noname@libreboot.org</i>; you + If you're worried about receiving spam, you can supply patches with a non-existent email address; see notes below about <em>noname@libreboot.org</em>; you can use this whether providing a name or not. The email address doesn't exist, and will just bounce. We do not require a way to contact you, so a working email address is not required. </p> @@ -80,12 +80,12 @@ <?php echo gettext("Generally speaking, using the same license as the file that you are modifying is much simpler."); ?> <?php echo gettext("If you are submitting new files, please make sure that they are under a free license (<a href='https://copyleft.org/'>copyleft</a> preferred)."); ?> <?php echo gettext("You can find a list on:"); ?> <a href="https://www.gnu.org/licenses/license-list.html">https://www.gnu.org/licenses/license-list.html</a>. NOTE: - not putting a copyright notice on a work does not mean it lacks copyright. Copyright is <i>automatic</i> in most countries. Not putting a license - on a work also does not make that work <i>free</i>; you have to declare a free license, otherwise the default, restrictive copyright laws apply for those + not putting a copyright notice on a work does not mean it lacks copyright. Copyright is <em>automatic</em> in most countries. Not putting a license + on a work also does not make that work <em>free</em>; you have to declare a free license, otherwise the default, restrictive copyright laws apply for those who wish to do anything with your work. Always put a license on your work! </p> <p> - Small technical note: libreboot is working to convert all documentation to <i>texinfo</i>, where + Small technical note: libreboot is working to convert all documentation to <em>texinfo</em>, where it is currently written in HTML, directly. Therefore, please submit any new documentation under this format, during the transition period. </p> <p> @@ -104,26 +104,26 @@ <h2 id="download"><?php echo gettext("How to download"); ?> <span class="r"><a href="#download">#download</a></span></h2> <p> - Libreboot development is facilitated by <i><a href="https://git-scm.com/">git</a></i>, a <i>distributed</i> version control system. + Libreboot development is facilitated by <em><a href="https://git-scm.com/">git</a></em>, a <em>distributed</em> version control system. You will need to install git (most GNU/Linux distributions package it in their repositories). </p> - <h3><?php echo gettext("Coreboot distribution. <i>This also contains the documentation</i>:"); ?></h3> + <h3><?php echo gettext("Coreboot distribution. <em>This also contains the documentation</em>:"); ?></h3> <p> Use this command, to download the repository:<br/> - <b>git clone <?php echo $lbFirmwareGitRepoAddress; ?></b><br/> + <strong>git clone <?php echo $lbFirmwareGitRepoAddress; ?></strong><br/> ...you can also <a href="<?php echo $lbFirmwareGitwebAddress; ?>">browse this repository on the web</a> </p> <p> - A new directory named <i><b>libreboot</b></i> will have been created, containing libreboot. + A new directory named <em><strong>libreboot</strong></em> will have been created, containing libreboot. </p> - <h3><?php echo gettext("Website. <i>Documentation is in the other repository</i>:"); ?></h3> + <h3><?php echo gettext("Website. <em>Documentation is in the other repository</em>:"); ?></h3> <p> Use this command, to download the repository:<br/> - <b>git clone <?php echo $lbWebsiteGitRepoAddress; ?></b><br/> + <strong>git clone <?php echo $lbWebsiteGitRepoAddress; ?></strong><br/> ...you can also <a href="<?php echo $lbWebsiteGitwebAddress; ?>">browse this repository on the web</a> </p> <p> - A new directory named <i><b>libreboot-website</b></i> will have been created, containing the libreboot website files. + A new directory named <em><strong>libreboot-website</strong></em> will have been created, containing the libreboot website files. </p> <p> <a href="#pagetop">Back to top of page</a> @@ -134,7 +134,7 @@ <div> <h2 id="contrib"><?php echo gettext("How to use git, for creating patches"); ?> <span class="r"><a href="#contrib">#contrib</a></span></h2> <p> - Libreboot development is facilitated by <i>git</i>, a <i>distributed</i> version control system that is in wide use today. Git provides many practical benefits, + Libreboot development is facilitated by <em>git</em>, a <em>distributed</em> version control system that is in wide use today. Git provides many practical benefits, making collective development of software very easy. </p> <p> @@ -142,70 +142,70 @@ </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 do not have to use your legal name; we don't care what name you use. Pseudonyms (alternative names) are OK. If you wish to be anonymous (no name), you can also use <i>Libreboot Contributor</i> as your name, and <i>noname@libreboot.org</i> as the email address. <i>We will happily accept anonymous contributions in the libreboot project.</i></b> + $ <strong>git config --global user.name "Your Name"</strong><br/> + $ <strong>git config --global user.email your@emailaddress.com</strong><br/> + <strong>NOTE: you do not have to use your legal name; we don't care what name you use. Pseudonyms (alternative names) are OK. If you wish to be anonymous (no name), you can also use <em>Libreboot Contributor</em> as your name, and <em>noname@libreboot.org</em> as the email address. <em>We will happily accept anonymous contributions in the libreboot project.</em></strong> </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> + $ <strong>git config --global core.editor nano</strong><br/> + $ <strong>git config --global color.status auto</strong><br/> + $ <strong>git config --global color.branch auto</strong><br/> + $ <strong>git config --global color.interactive auto</strong><br/> + $ <strong>git config --global color.diff auto</strong> </p> <p> - <b>NOTE: the above steps for colour make git use red/green font colours for showing diffs. If you are red/green colour-blind, please ignore the above steps. The default configuration in git is no-colour (all one colour, usually the default that your terminal uses). If you are colour-blind, git can display in other colours; refer - to the git documentation.</b> + <strong>NOTE: the above steps for colour make git use red/green font colours for showing diffs. If you are red/green colour-blind, please ignore the above steps. The default configuration in git is no-colour (all one colour, usually the default that your terminal uses). If you are colour-blind, git can display in other colours; refer + to the git documentation.</strong> </p> <p> - <?php echo gettext("Clone the git repository, and make your desired changes inside the newly created <i>libreboot</i> directory."); ?> + <?php echo gettext("Clone the git repository, and make your desired changes inside the newly created <em>libreboot</em> directory."); ?> <?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> - When working with git, you will need your current working directory to be inside the <i>libreboot</i> directory that was just created.<br/> - $ <b>cd libreboot/</b> + When working with git, you will need your current working directory to be inside the <em>libreboot</em> directory that was just created.<br/> + $ <strong>cd libreboot/</strong> </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> + $ <strong>git status</strong> </p> <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>)"); ?> + <?php echo gettext("The status command will show any untracked files that you have. Add them using <strong>git add path/to/file</strong>. 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 <strong>git rm path/to/file</strong>. As long as you have added all the untracked files, it is generally easier to use:"); ?><br/> + $ <strong>git commit -a</strong><br/> + <?php echo gettext("(instead of <strong>git commit</strong>)"); ?> </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/> + $ <strong>git commit --amend</strong><br/> <?php echo gettext("or:"); ?><br/> - $ <b>git commit -a --amend</b> + $ <strong>git commit -a --amend</strong> </p> <p> - If you wish to use a different author name for the commit command, add <b><i>--author="Author's Name <author's email address>"</i></b> at the end. This + If you wish to use a different author name for the commit command, add <strong><em>--author="Author's Name <author's email address>"</em></strong> at the end. This could be a pseudonym (alternative name), or it could be because you are submitting a patch on someone else's - behalf. <b>If you wish to be anonymous (no name), you can also use <i>Libreboot Contributor</i> as your name, and <i>noname@libreboot.org</i> as the email address. <i>We will happily accept anonymous contributions in the libreboot project.</i></b> + behalf. <strong>If you wish to be anonymous (no name), you can also use <em>Libreboot Contributor</em> as your name, and <em>noname@libreboot.org</em> as the email address. <em>We will happily accept anonymous contributions in the libreboot project.</em></strong> </p> <p> - Check once more that everything you want is added. Use the <b>git status</b> command to check for untracked changes/files, and adapt accordingly. - Once you've committed everything, your changes will appear in a <i>diff</i> format, using this command:<br/> - $ <b>git show</b><br/> - Use PgUp/PgDown to navigate the diff output. This uses the <i>less</i> utility, so all the features from that (e.g. keyword search) are also available. + Check once more that everything you want is added. Use the <strong>git status</strong> command to check for untracked changes/files, and adapt accordingly. + Once you've committed everything, your changes will appear in a <em>diff</em> format, using this command:<br/> + $ <strong>git show</strong><br/> + Use PgUp/PgDown to navigate the diff output. This uses the <em>less</em> utility, so all the features from that (e.g. keyword search) are also available. </p> <p> <?php echo gettext("In your local git tree, you can use this to check your commits:"); ?><br/> - $ <b>git log</b> + $ <strong>git log</strong> </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/> + $ <strong>git config --global --add alias.lol "log --graph --decorate --pretty=oneline --abbrev-commit --all"</strong><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."); ?> + $ <strong>git lol</strong><br/> + <?php echo gettext("This is like <strong>git log</strong>, but it's much better and shows branches, etc."); ?> </p> <h3><?php echo gettext("Method 1: host a repository"); ?></h3> <p> @@ -232,7 +232,7 @@ <?php for ($server=0; $server<count($lbFirmwareBackupGitRepoAddress); $server++) { ?> - $ <b>git clone <?php echo $lbFirmwareBackupGitRepoAddress[$server]; ?></b> + $ <strong>git clone <?php echo $lbFirmwareBackupGitRepoAddress[$server]; ?></strong> <?php if ($server!=count($lbFirmwareBackupGitRepoAddress)-1) echo "<br/>"; ?> <?php } @@ -244,7 +244,7 @@ <?php for ($server=0; $server<count($lbWebsiteBackupGitRepoAddress); $server++) { ?> - $ <b>git clone <?php echo $lbWebsiteBackupGitRepoAddress[$server]; ?></b> + $ <strong>git clone <?php echo $lbWebsiteBackupGitRepoAddress[$server]; ?></strong> <?php if ($server!=count($lbWebsiteBackupGitRepoAddress)-1) echo "<br/>"; ?> <?php } |