OpenHarmony/third_party_mesa3d
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
147,629 Commits 9 Branches 1 Tag
982c630cd500bd2ad24db9dbc2c5b8fd489350d4
Commit Graph

30 Commits

Author SHA1 Message Date
Eric Engestrom
df93e7aeee docs/submittingpatches: mention use of the -x flag of git cherry-pick when backporting a commit 
Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/13746>
 2021-11-15 22:47:39 +00:00
Eric Engestrom
d47bfd56de docs/submittingpatches: add formatting around the release branches names 
Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/13746>
 2021-11-15 22:47:39 +00:00
Eric Engestrom
162622bf63 docs/submittingpatches: add link to section describing how to make a backport MR 
Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/13746>
 2021-11-15 22:47:39 +00:00
Jordan Justen
57897b4095 docs: Rename master branch to main 
Signed-off-by: Jordan Justen <jordan.l.justen@intel.com>
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
 2021-05-05 12:21:00 -07:00
Erik Faye-Lund
72eca47c66 docs: someome -> someone 
A typo in the section about choice of language is a bit funny, but
let's fix it anyway ;)

Thanks to Ilia Mirkin for pointing this out.

Reviewed-by: Ilia Mirkin <imirkin@alum.mit.edu>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10464>
 2021-04-26 18:08:29 +02:00
Erik Faye-Lund
54ad6f91c6 docs: use code-block for console-content 
Reviewed-by: Eric Anholt <eric@anholt.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10281>
 2021-04-26 08:39:02 +00:00
Erik Faye-Lund
4f12a42841 docs: write basic meta-documentation 
We were previously completely lacking documentation on how to write
documentation. This adds some very basic docs for that.

Maybe at some point this could deserve it's own article, but for now
this seems enough.

This also documents the group-consensus on preferring US English that
was reached on the mesa-dev mailing list[1].

[1]: https://lists.freedesktop.org/archives/mesa-dev/2021-March/225023.html

Reviewed-by: Jason Ekstrand <jason@jlekstrand.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/9912>
 2021-04-21 18:26:55 +00:00
Erik Faye-Lund
7f4f441465 docs: quote "git log" 
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915>
 2020-09-30 08:18:21 +00:00
Erik Faye-Lund
50e26e5376 docs: git -> Git 
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915>
 2020-09-30 08:18:21 +00:00
Erik Faye-Lund
b8f1075c4e docs: url -> URL 
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6864>
 2020-09-28 07:54:25 +00:00
Erik Faye-Lund
7ee8a3a2cb docs: gitlab -> GitLab 
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6864>
 2020-09-28 07:54:25 +00:00
Frank Binns
fd91744bd4 docs: change "Fixes:" tag example to match git fixes output 
The "Fixes:" tag example has the commit title in double quotes, whereas the
suggested git fixes alias, a couple of lines below, also adds some outer
parenthesis.

Although there doesn't appear to be a consistent format for the "Fixes:" tag,
other than it should be a git commit sha followed by the commit title, the
information in the docs should at least be consistent. As the "Fixes:" tag was
inspired by the Linux kernel, which does have parenthesis, update the example to
match the git fixes output.

Signed-off-by: Frank Binns <frank.binns@imgtec.com>
Reviewed-by: Emil Velikov <emil.velikov@collabora.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6106>
 2020-07-29 15:25:24 +00:00
Eric Engestrom
be8a8edb1e docs/submittingpatches: add more than one Cc: mesa-stable example to the examples list 
Starting with that very example :)

Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Acked-by: Alyssa Rosenzweig <alyssa.rosenzweig@collabora.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5880>
 2020-07-13 19:33:25 +00:00
Erik Faye-Lund
b1c16e5251 docs: use ref-links for internal references 
Ref-link have two benefits over generic links:

1. They produce the right result for non-HTML outputs
2. They get validated at build-time

So let's use them for internal references instead.

Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5671>
 2020-06-28 09:06:57 +00:00
Erik Faye-Lund
5ee55b206a docs: fix internal references 
It seems last time I tried to fix these, I missed a few spots. So let's
try to get things right this time.

Fixes: 429ff05491 ("docs/relnotes: update internal references")
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5671>
 2020-06-28 09:06:57 +00:00
Erik Faye-Lund
1d250bf291 docs: restore accidentally dropped labels 
These were accidentally dropped when cleaning up the TOC, making links to
them dead. Because we used plain links, sphinx didn't inform us that
these became dead. Let's restore them.

Fixes: 14f2a81b6f ("docs: drop open-coded toc for articles")
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5671>
 2020-06-28 09:06:57 +00:00
Eric Engestrom
7b7d28ed6d docs: move "stable" tag explanation next to Fixes: 
Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Reviewed-by: Eric Anholt <eric@anholt.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5378>
 2020-06-19 19:51:53 +00:00
Eric Engestrom
a096d41094 docs: move Fixes: tag explanation to its own section 
This also adds the ability to link directly to it:
https://mesa3d.org/submittingpatches.html#fixes

Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Reviewed-by: Eric Anholt <eric@anholt.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5378>
 2020-06-19 19:51:53 +00:00
Eric Engestrom
7488d49107 docs: make it clear that the tags needs to be in the commit message 
Some people have been putting them only in the MR description, which
isn't picked up by our tools. (Note that doing both doesn't hurt.)

Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Reviewed-by: Eric Anholt <eric@anholt.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5378>
 2020-06-19 19:51:53 +00:00
Eric Engestrom
731465192a docs: reword a sentence a bit 
The "that you know ahead of time" bit just sounded weird as everything on this
page except the backport MR only applies if you know it "ahead of time".

Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Reviewed-by: Eric Anholt <eric@anholt.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5378>
 2020-06-19 19:51:53 +00:00
Eric Engestrom
5d27d5eb61 docs: add some formatting to the "backport merge request" option 
Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Reviewed-by: Eric Anholt <eric@anholt.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5378>
 2020-06-19 19:51:53 +00:00
Eric Engestrom
0e4eb7b86d docs: prefer Fixes: over Cc: mesa-stable 
`Fixes:` targets a specific commit and as such is much more precise and
useful than `Cc: mesa-stable`, so let's prefer it when applicable.

Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Reviewed-by: Eric Anholt <eric@anholt.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5378>
 2020-06-19 19:51:53 +00:00
Eric Engestrom
8fd9893123 docs: drop git sendemail instructions 
Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Reviewed-by: Eric Anholt <eric@anholt.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5378>
 2020-06-19 19:51:53 +00:00
Eric Engestrom
a29a1588b1 docs: reword "sending a patch revision" to "updating a merge request" 
Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Reviewed-by: Eric Anholt <eric@anholt.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5378>
 2020-06-19 19:51:53 +00:00
Eric Engestrom
fdebba2770 docs: stop considering Cc: mesa-stable as an email address 
Our tools haven't needed more than this ^ for a while, and the historical
reasons this used to be an email address don't matter anymore.

Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Reviewed-by: Eric Anholt <eric@anholt.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5378>
 2020-06-19 19:51:53 +00:00
Erik Faye-Lund
ea91f4769a README: update references to internal docs 
These documents are no longer HTML files, so the internal reference
should be updated.

Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
 2020-06-13 10:42:01 +00:00
Erik Faye-Lund
14f2a81b6f docs: drop open-coded toc for articles 
Sphinx already provides a proper table-of-contents, so we don't need to
roll our own.

Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
 2020-06-13 10:42:01 +00:00
Erik Faye-Lund
d6be994ef8 docs: use code-blocks 
Sphinx can syntax-highlight a block if we use the right syntax.

Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
 2020-06-13 10:42:00 +00:00
Erik Faye-Lund
bf3f0f7a82 docs: format notes as rst-notes 
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
 2020-06-13 10:42:00 +00:00
Erik Faye-Lund
4d066836e3 docs: convert articles to reructuredtext 
This uses the previously added scripts to convert the documentation to
reStructuredText, which is both easier to read offline, and can be used
to generate modern HTML for online documentation.

No modification to the generated results have been done.

Acked-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
 2020-06-13 10:42:00 +00:00