From 50e26e5376e542b6c6483bcfd689ffd5ffd20369 Mon Sep 17 00:00:00 2001 From: Erik Faye-Lund Date: Tue, 29 Sep 2020 18:57:33 +0200 Subject: [PATCH] docs: git -> Git Reviewed-by: Eric Engestrom Part-of: --- docs/ci/bare-metal.rst | 2 +- docs/ci/index.rst | 4 ++-- docs/download.rst | 2 +- docs/helpwanted.rst | 2 +- docs/lists.rst | 2 +- docs/releasing.rst | 2 +- docs/repository.rst | 26 +++++++++++++------------- docs/sourcedocs.rst | 2 +- docs/submittingpatches.rst | 4 ++-- docs/systems.rst | 2 +- docs/thanks.rst | 2 +- docs/vmware-guest.rst | 2 +- 12 files changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/ci/bare-metal.rst b/docs/ci/bare-metal.rst index 754c78d63af..9bcec535e60 100644 --- a/docs/ci/bare-metal.rst +++ b/docs/ci/bare-metal.rst @@ -8,7 +8,7 @@ supported. In comparison with LAVA, this doesn't involve maintaining a separate web service with its own job scheduler and replicating jobs between the -two. It also places more of the board support in git, instead of +two. It also places more of the board support in Git, instead of web service configuration. On the other hand, the serial interactions and bootloader support are more primitive. diff --git a/docs/ci/index.rst b/docs/ci/index.rst index ad40692030b..2b1ff5366fb 100644 --- a/docs/ci/index.rst +++ b/docs/ci/index.rst @@ -4,7 +4,7 @@ Continuous Integration GitLab CI --------- -GitLab provides a convenient framework for running commands in response to git pushes. +GitLab provides a convenient framework for running commands in response to Git pushes. We use it to test merge requests (MRs) before merging them (pre-merge testing), as well as post-merge testing, for everything that hits ``master`` (this is necessary because we still allow commits to be pushed outside of MRs, @@ -167,7 +167,7 @@ to build it. So, when developing any change to container build scripts, you need to update the associated ``FDO_DISTRIBUTION_TAG`` to a new unique string. We recommend using the current date plus some string related to your branch (so that if you rebase on someone else's -container update from the same day, you will get a git conflict +container update from the same day, you will get a Git conflict instead of silently reusing their container) When developing a given change to your Docker image, you would have to diff --git a/docs/download.rst b/docs/download.rst index a7c7ea3615c..53321e43551 100644 --- a/docs/download.rst +++ b/docs/download.rst @@ -58,7 +58,7 @@ The Mesa demos collection is available In the past, GLUT, GLU and the Mesa demos were released in conjunction with Mesa releases. But since GLUT, GLU and the demos change -infrequently, they were split off into their own git repositories: +infrequently, they were split off into their own Git repositories: `GLUT `__, `GLU `__ and `Demos `__, diff --git a/docs/helpwanted.rst b/docs/helpwanted.rst index dcee4fd7c01..8c5eafb2143 100644 --- a/docs/helpwanted.rst +++ b/docs/helpwanted.rst @@ -7,7 +7,7 @@ specific ideas and areas where help would be appreciated: #. **Driver patching and testing.** Patches are often posted to the `mesa-dev mailing list `__, - but aren't immediately checked into git because not enough people are + but aren't immediately checked into Git because not enough people are testing them. Just applying patches, testing and reporting back is helpful. #. **Driver debugging.** There are plenty of open bugs in the `bug diff --git a/docs/lists.rst b/docs/lists.rst index 0a1a0b1f757..fdef2bdecc2 100644 --- a/docs/lists.rst +++ b/docs/lists.rst @@ -13,7 +13,7 @@ These are the primary Mesa 3D / DRI mailing lists: beginners. - `mesa-commit `__ - - relays git check-in messages (for developers). In general, people + - relays Git check-in messages (for developers). In general, people should not post to this list. - `mesa-announce `__ diff --git a/docs/releasing.rst b/docs/releasing.rst index af6b86853a5..d196ce659f2 100644 --- a/docs/releasing.rst +++ b/docs/releasing.rst @@ -311,7 +311,7 @@ Then run the , where X.Y.Z is the version you just made. This will update docs/relnotes.rst and docs/release-calendar.rst. It will then generate -a git commit automatically. Check that everything looks correct and +a Git commit automatically. Check that everything looks correct and push: :: diff --git a/docs/repository.rst b/docs/repository.rst index 4f5c2477206..4d32c7a09dd 100644 --- a/docs/repository.rst +++ b/docs/repository.rst @@ -1,29 +1,29 @@ Source Code Repository ====================== -Mesa uses `git `__ as its source code management +Mesa uses `Git `__ as its source code management system. -The master git repository is hosted on +The master Git repository is hosted on `freedesktop.org `__. You may access the repository either as an :ref:`anonymous user ` (read-only) or as a :ref:`developer ` (read/write). -You may also `browse the main Mesa git +You may also `browse the main Mesa Git repository `__ and the `Mesa -demos and tests git +demos and tests Git repository `__. .. _anonymous: -Anonymous git Access +Anonymous Git Access -------------------- To get the Mesa sources anonymously (read-only): -#. Install the git software on your computer if needed. +#. Install the Git software on your computer if needed. #. Get an initial, local copy of the repository with: :: @@ -44,7 +44,7 @@ To get the Mesa sources anonymously (read-only): .. _developer: -Developer git Access +Developer Git Access -------------------- If you wish to become a Mesa developer with GitLab merge privilege, @@ -84,7 +84,7 @@ create a token, and put it in the URL as shown here: Windows Users ------------- -If you're `using git on +If you're `using Git on Windows `__ you'll want to enable automatic CR/LF conversion in your local copy of the repository: @@ -93,7 +93,7 @@ repository: git config --global core.autocrlf true -This will cause git to convert all text files to CR+LF on checkout, and +This will cause Git to convert all text files to CR+LF on checkout, and to LF on commit. Unix users don't need to set this option. @@ -115,7 +115,7 @@ Developer Git Tips #. Setting up to edit the master branch - If you try to do a pull by just saying\ ``git pull`` and git + If you try to do a pull by just saying\ ``git pull`` and Git complains that you have not specified a branch, try: :: @@ -128,7 +128,7 @@ Developer Git Tips #. Small changes to master - If you are an experienced git user working on substantial + If you are an experienced Git user working on substantial modifications, you are probably working on a separate branch and would rebase your branch prior to merging with master. But for small changes to the master branch itself, you also need to use the rebase @@ -154,7 +154,7 @@ Developer Git Tips It is possible (and likely) that someone has changed master since you did your last pull. Even if your changes do not conflict with their - changes, git will make a fast-forward merge branch, branching from + changes, Git will make a fast-forward merge branch, branching from the point in time where you did your last pull and merging it to a point after the other changes. @@ -168,7 +168,7 @@ Developer Git Tips If you are familiar with CVS or similar system, this is similar to doing a ``cvs update`` in order to update your source tree to the current repository state, instead of the time you did the last - update. (CVS doesn't work like git in this respect, but this is + update. (CVS doesn't work like Git in this respect, but this is easiest way to explain it.) In any case, your repository now looks like you made your changes diff --git a/docs/sourcedocs.rst b/docs/sourcedocs.rst index 0499cf8c720..348acafc17e 100644 --- a/docs/sourcedocs.rst +++ b/docs/sourcedocs.rst @@ -6,7 +6,7 @@ cross-referenced documentation from the Mesa source code. The Doxygen configuration files and generated files are not included in the normal Mesa distribution (they're very large). To generate Doxygen -documentation, download Mesa from git, change to the ``doxygen`` +documentation, download Mesa from Git, change to the ``doxygen`` directory and run ``make``. For an example of Doxygen usage in Mesa, see a recent source file such diff --git a/docs/submittingpatches.rst b/docs/submittingpatches.rst index a24ccd6c737..f4e20b91621 100644 --- a/docs/submittingpatches.rst +++ b/docs/submittingpatches.rst @@ -13,7 +13,7 @@ Basic guidelines - Whenever possible, patches should only affect individual Mesa/Gallium components. - Patches should never introduce build breaks and should be bisectable - (see ``git bisect``.) + (see ``Git bisect``.) - Patches should be properly :ref:`formatted `. - Patches should be sufficiently :ref:`tested ` before submitting. @@ -25,7 +25,7 @@ Basic guidelines Patch formatting ---------------- -- Lines should be limited to 75 characters or less so that git logs +- Lines should be limited to 75 characters or less so that Git logs displayed in 80-column terminals avoid line wrapping. Note that git log uses 4 spaces of indentation (4 + 75 < 80). - The first line should be a short, concise summary of the change diff --git a/docs/systems.rst b/docs/systems.rst index 0e3e66c1a22..b57b247435a 100644 --- a/docs/systems.rst +++ b/docs/systems.rst @@ -55,7 +55,7 @@ Deprecated Systems and Drivers In the past there were other drivers for older GPUs and operating systems. These have been removed from the Mesa source tree and distribution. If anyone's interested though, the code can be found in -the git repo. The list includes: +the Git repo. The list includes: - 3dfx/glide - Matrox diff --git a/docs/thanks.rst b/docs/thanks.rst index d6692ba5f9e..46cb9736d1d 100644 --- a/docs/thanks.rst +++ b/docs/thanks.rst @@ -15,7 +15,7 @@ somewhat dated, unfortunately. - Precision Insight, Inc., VA Linux Systems, Inc., and most recently, Tungsten Graphics, Inc. have supported the ongoing development of Mesa. -- The `Mesa `__ website and git repository are +- The `Mesa `__ website and Git repository are hosted by `freedesktop.org `__. - `alt.software `__ contributed the Direct3D driver. diff --git a/docs/vmware-guest.rst b/docs/vmware-guest.rst index 2005c543fbb..d1ca1bccca4 100644 --- a/docs/vmware-guest.rst +++ b/docs/vmware-guest.rst @@ -126,7 +126,7 @@ Begin by saving your current directory location: - libdrm, a user-space library that interfaces with DRM. Most distros ship with this but it's safest to install a newer version. To get the - latest code from git: + latest code from Git: ::