From b7f2b8ed1053131ecf946e154cc2e85735ba976e Mon Sep 17 00:00:00 2001
From: Francis Rowe
- Using your legal name is not required when submitting patches to libreboot. For reasons why we have this policy, read this article. 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 without a name, if you want or need to do that (instructions are provided on this page). Also, read this article. 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 not required when submitting patches to libreboot. For reasons why we have this policy, read this article. 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 without a name, if you want or need to do that (instructions are provided on this page). Also, read this article. 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.
- When submitting any kind of documentation, try not to use the terms him/her, she/he, his/her, or anything that is gender biased. Use their, they, them, those people, that person, and so on. You are making a huge difference. + When submitting any kind of documentation, try not to use the terms him/her, she/he, his/her, or anything that is gender biased. Use their, they, them, those people, that person, and so on. You are making a huge difference.
- If you're worried about receiving spam, you can supply patches with a non-existent email address; see notes below about noname@libreboot.org; you + If you're worried about receiving spam, you can supply patches with a non-existent email address; see notes below about noname@libreboot.org; 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.
@@ -80,12 +80,12 @@ copyleft preferred)."); ?> https://www.gnu.org/licenses/license-list.html. NOTE: - not putting a copyright notice on a work does not mean it lacks copyright. Copyright is automatic in most countries. Not putting a license - on a work also does not make that work free; 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 automatic in most countries. Not putting a license + on a work also does not make that work free; 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!- Small technical note: libreboot is working to convert all documentation to texinfo, where + Small technical note: libreboot is working to convert all documentation to texinfo, where it is currently written in HTML, directly. Therefore, please submit any new documentation under this format, during the transition period.
@@ -104,26 +104,26 @@
- Libreboot development is facilitated by git, a distributed version control system. + Libreboot development is facilitated by git, a distributed version control system. You will need to install git (most GNU/Linux distributions package it in their repositories).
-
Use this command, to download the repository:
- git clone
+ git clone
...you can also browse this repository on the web
- A new directory named libreboot will have been created, containing libreboot. + A new directory named libreboot will have been created, containing libreboot.
-
Use this command, to download the repository:
- git clone
+ git clone
...you can also browse this repository on the web
- A new directory named libreboot-website will have been created, containing the libreboot website files. + A new directory named libreboot-website will have been created, containing the libreboot website files.
Back to top of page @@ -134,7 +134,7 @@
- Libreboot development is facilitated by git, a distributed version control system that is in wide use today. Git provides many practical benefits, + Libreboot development is facilitated by git, a distributed version control system that is in wide use today. Git provides many practical benefits, making collective development of software very easy.
@@ -142,70 +142,70 @@
- $ git config --global user.name "Your Name"
- $ git config --global user.email your@emailaddress.com
- 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 Libreboot Contributor as your name, and noname@libreboot.org as the email address. We will happily accept anonymous contributions in the libreboot project.
+ $ git config --global user.name "Your Name"
+ $ git config --global user.email your@emailaddress.com
+ 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 Libreboot Contributor as your name, and noname@libreboot.org as the email address. We will happily accept anonymous contributions in the libreboot project.
- $ git config --global core.editor nano
- $ git config --global color.status auto
- $ git config --global color.branch auto
- $ git config --global color.interactive auto
- $ git config --global color.diff auto
+ $ git config --global core.editor nano
+ $ git config --global color.status auto
+ $ git config --global color.branch auto
+ $ git config --global color.interactive auto
+ $ git config --global color.diff auto
- 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. + 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.
- libreboot directory."); ?> + libreboot directory."); ?>
- When working with git, you will need your current working directory to be inside the libreboot directory that was just created.
- $ cd libreboot/
+ When working with git, you will need your current working directory to be inside the libreboot directory that was just created.
+ $ cd libreboot/
- $ git status
+ $ git status
- git add path/to/file. 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 git rm path/to/file. As long as you have added all the untracked files, it is generally easier to use:"); ?>
- $ git commit -a
- git commit)"); ?>
+ git add path/to/file. 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 git rm path/to/file. As long as you have added all the untracked files, it is generally easier to use:"); ?>
+ $ git commit -a
+ git commit)"); ?>
- $ git commit --amend
+ $ git commit --amend
- $ git commit -a --amend
+ $ git commit -a --amend
- If you wish to use a different author name for the commit command, add --author="Author's Name <author's email address>" at the end. This + If you wish to use a different author name for the commit command, add --author="Author's Name <author's email address>" 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. If you wish to be anonymous (no name), you can also use Libreboot Contributor as your name, and noname@libreboot.org as the email address. We will happily accept anonymous contributions in the libreboot project. + behalf. If you wish to be anonymous (no name), you can also use Libreboot Contributor as your name, and noname@libreboot.org as the email address. We will happily accept anonymous contributions in the libreboot project.
- Check once more that everything you want is added. Use the git status command to check for untracked changes/files, and adapt accordingly.
- Once you've committed everything, your changes will appear in a diff format, using this command:
- $ git show
- Use PgUp/PgDown to navigate the diff output. This uses the less 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 git status command to check for untracked changes/files, and adapt accordingly.
+ Once you've committed everything, your changes will appear in a diff format, using this command:
+ $ git show
+ Use PgUp/PgDown to navigate the diff output. This uses the less utility, so all the features from that (e.g. keyword search) are also available.
- $ git log
+ $ git log
- $ git config --global --add alias.lol "log --graph --decorate --pretty=oneline --abbrev-commit --all"
+ $ git config --global --add alias.lol "log --graph --decorate --pretty=oneline --abbrev-commit --all"
- $ git lol
- git log, but it's much better and shows branches, etc."); ?>
+ $ git lol
+ git log, but it's much better and shows branches, etc."); ?>
@@ -232,7 +232,7 @@ - $ git clone + $ git clone "; ?> - $ git clone + $ git clone "; ?>