docs: git -> Git
Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915>
This commit is contained in:
parent
24e8e53bac
commit
50e26e5376
|
@ -8,7 +8,7 @@ supported.
|
||||||
|
|
||||||
In comparison with LAVA, this doesn't involve maintaining a separate
|
In comparison with LAVA, this doesn't involve maintaining a separate
|
||||||
web service with its own job scheduler and replicating jobs between the
|
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
|
web service configuration. On the other hand, the serial interactions
|
||||||
and bootloader support are more primitive.
|
and bootloader support are more primitive.
|
||||||
|
|
||||||
|
|
|
@ -4,7 +4,7 @@ Continuous Integration
|
||||||
GitLab CI
|
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),
|
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``
|
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,
|
(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
|
scripts, you need to update the associated ``FDO_DISTRIBUTION_TAG`` to
|
||||||
a new unique string. We recommend using the current date plus some
|
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
|
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)
|
instead of silently reusing their container)
|
||||||
|
|
||||||
When developing a given change to your Docker image, you would have to
|
When developing a given change to your Docker image, you would have to
|
||||||
|
|
|
@ -58,7 +58,7 @@ The Mesa demos collection is available
|
||||||
|
|
||||||
In the past, GLUT, GLU and the Mesa demos were released in conjunction
|
In the past, GLUT, GLU and the Mesa demos were released in conjunction
|
||||||
with Mesa releases. But since GLUT, GLU and the demos change
|
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 <https://gitlab.freedesktop.org/mesa/glut>`__,
|
`GLUT <https://gitlab.freedesktop.org/mesa/glut>`__,
|
||||||
`GLU <https://gitlab.freedesktop.org/mesa/glu>`__ and
|
`GLU <https://gitlab.freedesktop.org/mesa/glu>`__ and
|
||||||
`Demos <https://gitlab.freedesktop.org/mesa/demos>`__,
|
`Demos <https://gitlab.freedesktop.org/mesa/demos>`__,
|
||||||
|
|
|
@ -7,7 +7,7 @@ specific ideas and areas where help would be appreciated:
|
||||||
#. **Driver patching and testing.** Patches are often posted to the
|
#. **Driver patching and testing.** Patches are often posted to the
|
||||||
`mesa-dev mailing
|
`mesa-dev mailing
|
||||||
list <https://lists.freedesktop.org/mailman/listinfo/mesa-dev>`__,
|
list <https://lists.freedesktop.org/mailman/listinfo/mesa-dev>`__,
|
||||||
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
|
testing them. Just applying patches, testing and reporting back is
|
||||||
helpful.
|
helpful.
|
||||||
#. **Driver debugging.** There are plenty of open bugs in the `bug
|
#. **Driver debugging.** There are plenty of open bugs in the `bug
|
||||||
|
|
|
@ -13,7 +13,7 @@ These are the primary Mesa 3D / DRI mailing lists:
|
||||||
beginners.
|
beginners.
|
||||||
|
|
||||||
- `mesa-commit <https://lists.freedesktop.org/mailman/listinfo/mesa-commit>`__
|
- `mesa-commit <https://lists.freedesktop.org/mailman/listinfo/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.
|
should not post to this list.
|
||||||
|
|
||||||
- `mesa-announce <https://lists.freedesktop.org/mailman/listinfo/mesa-announce>`__
|
- `mesa-announce <https://lists.freedesktop.org/mailman/listinfo/mesa-announce>`__
|
||||||
|
|
|
@ -311,7 +311,7 @@ Then run the
|
||||||
|
|
||||||
, where X.Y.Z is the version you just made. This will update
|
, 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
|
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:
|
push:
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
|
@ -1,29 +1,29 @@
|
||||||
Source Code Repository
|
Source Code Repository
|
||||||
======================
|
======================
|
||||||
|
|
||||||
Mesa uses `git <https://git-scm.com>`__ as its source code management
|
Mesa uses `Git <https://git-scm.com>`__ as its source code management
|
||||||
system.
|
system.
|
||||||
|
|
||||||
The master git repository is hosted on
|
The master Git repository is hosted on
|
||||||
`freedesktop.org <https://www.freedesktop.org>`__.
|
`freedesktop.org <https://www.freedesktop.org>`__.
|
||||||
|
|
||||||
You may access the repository either as an :ref:`anonymous
|
You may access the repository either as an :ref:`anonymous
|
||||||
user <anonymous>` (read-only) or as a :ref:`developer <developer>`
|
user <anonymous>` (read-only) or as a :ref:`developer <developer>`
|
||||||
(read/write).
|
(read/write).
|
||||||
|
|
||||||
You may also `browse the main Mesa git
|
You may also `browse the main Mesa Git
|
||||||
repository <https://gitlab.freedesktop.org/mesa/mesa>`__ and the `Mesa
|
repository <https://gitlab.freedesktop.org/mesa/mesa>`__ and the `Mesa
|
||||||
demos and tests git
|
demos and tests Git
|
||||||
repository <https://gitlab.freedesktop.org/mesa/demos>`__.
|
repository <https://gitlab.freedesktop.org/mesa/demos>`__.
|
||||||
|
|
||||||
.. _anonymous:
|
.. _anonymous:
|
||||||
|
|
||||||
Anonymous git Access
|
Anonymous Git Access
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
To get the Mesa sources anonymously (read-only):
|
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:
|
#. Get an initial, local copy of the repository with:
|
||||||
|
|
||||||
::
|
::
|
||||||
|
@ -44,7 +44,7 @@ To get the Mesa sources anonymously (read-only):
|
||||||
|
|
||||||
.. _developer:
|
.. _developer:
|
||||||
|
|
||||||
Developer git Access
|
Developer Git Access
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
If you wish to become a Mesa developer with GitLab merge privilege,
|
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
|
Windows Users
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
If you're `using git on
|
If you're `using Git on
|
||||||
Windows <https://git.wiki.kernel.org/index.php/WindowsInstall>`__ you'll
|
Windows <https://git.wiki.kernel.org/index.php/WindowsInstall>`__ you'll
|
||||||
want to enable automatic CR/LF conversion in your local copy of the
|
want to enable automatic CR/LF conversion in your local copy of the
|
||||||
repository:
|
repository:
|
||||||
|
@ -93,7 +93,7 @@ repository:
|
||||||
|
|
||||||
git config --global core.autocrlf true
|
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.
|
to LF on commit.
|
||||||
|
|
||||||
Unix users don't need to set this option.
|
Unix users don't need to set this option.
|
||||||
|
@ -115,7 +115,7 @@ Developer Git Tips
|
||||||
|
|
||||||
#. Setting up to edit the master branch
|
#. 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:
|
complains that you have not specified a branch, try:
|
||||||
|
|
||||||
::
|
::
|
||||||
|
@ -128,7 +128,7 @@ Developer Git Tips
|
||||||
|
|
||||||
#. Small changes to master
|
#. 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
|
modifications, you are probably working on a separate branch and
|
||||||
would rebase your branch prior to merging with master. But for small
|
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
|
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
|
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
|
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
|
the point in time where you did your last pull and merging it to a
|
||||||
point after the other changes.
|
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
|
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
|
doing a ``cvs update`` in order to update your source tree to the
|
||||||
current repository state, instead of the time you did the last
|
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.)
|
easiest way to explain it.)
|
||||||
|
|
||||||
In any case, your repository now looks like you made your changes
|
In any case, your repository now looks like you made your changes
|
||||||
|
|
|
@ -6,7 +6,7 @@ cross-referenced documentation from the Mesa source code.
|
||||||
|
|
||||||
The Doxygen configuration files and generated files are not included in
|
The Doxygen configuration files and generated files are not included in
|
||||||
the normal Mesa distribution (they're very large). To generate Doxygen
|
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``.
|
directory and run ``make``.
|
||||||
|
|
||||||
For an example of Doxygen usage in Mesa, see a recent source file such
|
For an example of Doxygen usage in Mesa, see a recent source file such
|
||||||
|
|
|
@ -13,7 +13,7 @@ Basic guidelines
|
||||||
- Whenever possible, patches should only affect individual Mesa/Gallium
|
- Whenever possible, patches should only affect individual Mesa/Gallium
|
||||||
components.
|
components.
|
||||||
- Patches should never introduce build breaks and should be bisectable
|
- Patches should never introduce build breaks and should be bisectable
|
||||||
(see ``git bisect``.)
|
(see ``Git bisect``.)
|
||||||
- Patches should be properly :ref:`formatted <formatting>`.
|
- Patches should be properly :ref:`formatted <formatting>`.
|
||||||
- Patches should be sufficiently :ref:`tested <testing>` before
|
- Patches should be sufficiently :ref:`tested <testing>` before
|
||||||
submitting.
|
submitting.
|
||||||
|
@ -25,7 +25,7 @@ Basic guidelines
|
||||||
Patch formatting
|
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
|
displayed in 80-column terminals avoid line wrapping. Note that git
|
||||||
log uses 4 spaces of indentation (4 + 75 < 80).
|
log uses 4 spaces of indentation (4 + 75 < 80).
|
||||||
- The first line should be a short, concise summary of the change
|
- The first line should be a short, concise summary of the change
|
||||||
|
|
|
@ -55,7 +55,7 @@ Deprecated Systems and Drivers
|
||||||
In the past there were other drivers for older GPUs and operating
|
In the past there were other drivers for older GPUs and operating
|
||||||
systems. These have been removed from the Mesa source tree and
|
systems. These have been removed from the Mesa source tree and
|
||||||
distribution. If anyone's interested though, the code can be found in
|
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
|
- 3dfx/glide
|
||||||
- Matrox
|
- Matrox
|
||||||
|
|
|
@ -15,7 +15,7 @@ somewhat dated, unfortunately.
|
||||||
- Precision Insight, Inc., VA Linux Systems, Inc., and most recently,
|
- Precision Insight, Inc., VA Linux Systems, Inc., and most recently,
|
||||||
Tungsten Graphics, Inc. have supported the ongoing development of
|
Tungsten Graphics, Inc. have supported the ongoing development of
|
||||||
Mesa.
|
Mesa.
|
||||||
- The `Mesa <https://www.mesa3d.org>`__ website and git repository are
|
- The `Mesa <https://www.mesa3d.org>`__ website and Git repository are
|
||||||
hosted by `freedesktop.org <https://freedesktop.org/>`__.
|
hosted by `freedesktop.org <https://freedesktop.org/>`__.
|
||||||
- `alt.software <http://web.archive.org/web/20131110021426/http://www.altsoftware.com/>`__
|
- `alt.software <http://web.archive.org/web/20131110021426/http://www.altsoftware.com/>`__
|
||||||
contributed the Direct3D driver.
|
contributed the Direct3D driver.
|
||||||
|
|
|
@ -126,7 +126,7 @@ Begin by saving your current directory location:
|
||||||
|
|
||||||
- libdrm, a user-space library that interfaces with DRM. Most distros
|
- 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
|
ship with this but it's safest to install a newer version. To get the
|
||||||
latest code from git:
|
latest code from Git:
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue