Skip to content

Commit 309abc9

Browse files
markdownlint: clean up all warnings
This is a [mostly] format-only change to get the repository into a state where it conforms with markdownlint. Signed-off-by: Patrick Williams <[email protected]> Change-Id: Ia07c7b3540cff8b25b7093f715c6617644340036
1 parent 3a2974d commit 309abc9

File tree

106 files changed

+2572
-2481
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

106 files changed

+2572
-2481
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ help you resolve them.
1717
OpenBMC relies on the Open Compute Project to provide guidelines on inclusive
1818
naming. The OCP guidelines can be found here:
1919

20-
https://www.opencompute.org/documents/ocp-terminology-guidelines-for-inclusion-and-openness
20+
<https://www.opencompute.org/documents/ocp-terminology-guidelines-for-inclusion-and-openness>
2121

2222
## Structure
2323

@@ -47,7 +47,7 @@ If you work for someone, consider asking them to execute the corporate CLA. This
4747
allows other contributors that work for your employer to skip the CLA signing
4848
process, they can just be added to the existing CCLA Schedule A.
4949

50-
After signing a CLA, send it to [email protected].
50+
After signing a CLA, send it to <[email protected]>.
5151

5252
If you're looking for a place to get started with OpenBMC, you may want to take
5353
a look at the issues tagged with 'bitesize'. These are fixes or enhancements
@@ -56,12 +56,12 @@ for a newcomer to start working with.
5656

5757
Check out that list here:
5858

59-
https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Aopenbmc+label%3Abitesize
59+
<https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Aopenbmc+label%3Abitesize>
6060

6161
If you need further details on any of these issues, feel free to add comments.
6262

6363
Performing code reviews is another good way to get started. Go to
64-
https://gerrit.openbmc.org and click on the "all" and "open" menu items, or if
64+
<https://gerrit.openbmc.org> and click on the "all" and "open" menu items, or if
6565
you are interested in a particular repository - for example, "bmcweb" - type
6666
"status:open project:openbmc/bmcweb" into the search bar and press the "search"
6767
button. Then select a review. Remember to be positive and add value with every
@@ -78,7 +78,7 @@ upstream project. Otherwise, conventions are chosen based on the language.
7878
Python source should all conform to PEP8. This style is well established within
7979
the Python community and can be verified with the 'pycodestyle' tool.
8080

81-
https://www.python.org/dev/peps/pep-0008/
81+
<https://www.python.org/dev/peps/pep-0008/>
8282

8383
### Python Formatting
8484

@@ -91,7 +91,7 @@ OpenBMC standards for Python match with PEP 8 so in general, a blank setup.cfg
9191
file is all that's needed. If so desired, enforcement of 80 (vs. the default 79)
9292
chars is fine as well:
9393

94-
```
94+
```toml
9595
[pycodestyle]
9696
max-line-length = 80
9797
```
@@ -102,7 +102,7 @@ they are not unanimously accepted and PEP 8 does not enforce them. It is at the
102102
repository maintainer's discretion as to whether to enforce the aforementioned
103103
rules. These rules can be enforced by adding the following to the setup.cfg:
104104

105-
```
105+
```toml
106106
[pycodestyle]
107107
ignore= NONE
108108
```
@@ -123,7 +123,7 @@ We follow the
123123

124124
For C code, we typically use the Linux coding style, which is documented at:
125125

126-
http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/submitting-patches.rst
126+
<http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/submitting-patches.rst>
127127

128128
In short:
129129

@@ -135,7 +135,9 @@ In short:
135135

136136
This style can mostly be verified with 'astyle' as follows:
137137

138-
astyle --style=linux --indent=tab=8 --indent=force-tab=8
138+
```bash
139+
astyle --style=linux --indent=tab=8 --indent=force-tab=8
140+
```
139141

140142
### C++
141143

@@ -235,11 +237,13 @@ practice in many projects which use Git.
235237
Exceptions to this are allowed in the form of links, which can be represented in
236238
the form of:
237239

238-
''' This implements [1]
240+
```markdown
241+
This implements [1]
239242

240243
....
241244

242-
[1] https://openbmc.org/myverylongurl. '''
245+
[1]: https://openbmc.org/myverylongurl.
246+
```
243247

244248
All commit messages must include a "Signed-off-by" line, which indicates that
245249
you the contributor have agreed to the Developer Certificate of Origin (see
@@ -258,7 +262,7 @@ different projects depend on each other).
258262
Commit messages should include a "Tested" field describing how you tested the
259263
code changes in the patch. Example:
260264

261-
```
265+
```text
262266
Tested: I ran unit tests with "make check" (added 2 new tests) and manually
263267
tested on Witherspoon that Foo daemon no longer crashes at boot.
264268
```
@@ -272,32 +276,31 @@ field.
272276

273277
The guidelines in the Linux kernel are very useful:
274278

275-
https://www.kernel.org/doc/html/latest/process/submitting-patches.html
276-
277-
https://www.kernel.org/doc/html/latest/process/submit-checklist.html
279+
- <https://www.kernel.org/doc/html/latest/process/submitting-patches.html>
280+
- <https://www.kernel.org/doc/html/latest/process/submit-checklist.html>
278281

279282
Your contribution will generally need to be reviewed before being accepted.
280283

281284
## Submitting changes via Gerrit server to OpenBMC
282285

283286
The OpenBMC Gerrit server supports GitHub credentials, its link is:
284287

285-
https://gerrit.openbmc.org/#/q/status:open
288+
<https://gerrit.openbmc.org/#/q/status:open>
286289

287290
_One time setup_: Login to the WebUI with your GitHub credentials and verify on
288291
your Account Settings that your SSH keys were imported:
289292

290-
https://gerrit.openbmc.org/#/settings/
293+
<https://gerrit.openbmc.org/#/settings/>
291294

292295
Most repositories are supported by the Gerrit server, the current list can be
293296
found under Projects -> List:
294297

295-
https://gerrit.openbmc.org/#/admin/projects/
298+
<https://gerrit.openbmc.org/#/admin/projects/>
296299

297300
If you're going to be working with Gerrit often, it's useful to create an SSH
298301
host block in ~/.ssh/config. Ex:
299302

300-
```
303+
```text
301304
Host openbmc.gerrit
302305
Hostname gerrit.openbmc.org
303306
Port 29418
@@ -325,7 +328,7 @@ to identify commits that belong to the same review. Configure your git
325328
repository to automatically add a Change-Id to your commit messages. The steps
326329
are:
327330

328-
```
331+
```bash
329332
gitdir=$(git rev-parse --git-dir)
330333
curl https://gerrit.openbmc.org/tools/hooks/commit-msg -o ${gitdir}/hooks/commit-msg
331334
chmod +x ${gitdir}/hooks/commit-msg`
@@ -381,9 +384,9 @@ no dependencies on non-public resources (URLs, repositories, etc).
381384
382385
- D-Bus interfaces are defined in the `phosphor-dbus-interfaces` repository at:
383386
384-
https://github.com/openbmc/phosphor-dbus-interfaces
387+
<https://github.com/openbmc/phosphor-dbus-interfaces>
385388
386-
See: http://dbus.freedesktop.org/doc/dbus-api-design.html
389+
See: <http://dbus.freedesktop.org/doc/dbus-api-design.html>
387390
388391
## Best practices for C
389392
@@ -455,6 +458,7 @@ on its own.
455458
456459
## Developer's Certificate of Origin 1.1
457460
461+
```text
458462
By making a contribution to this project, I certify that:
459463
460464
(a) The contribution was created in whole or in part by me and I
@@ -478,3 +482,4 @@ on its own.
478482
personal information I submit with it, including my sign-off) is
479483
maintained indefinitely and may be redistributed consistent with
480484
this project or the open source license(s) involved.
485+
```

0 commit comments

Comments
 (0)