Skip to content

Commit d0c3aa6

Browse files
committed
markdownlint-cli2 --fix src/**/*.md
Signed-off-by: Daniel Maslowski <[email protected]>
1 parent 6e1733c commit d0c3aa6

File tree

6 files changed

+44
-27
lines changed

6 files changed

+44
-27
lines changed

src/case_studies/TiogaPass.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ Corporation](http://www.wiwynn.com/english).
1414

1515
It contains following sections:
1616

17-
* [Quick Start](#Quick-Start)
18-
* [Details](#Details)
19-
* [How to build](#How-to-build)
20-
* [How to operate](#How-to-operate)
21-
* [Platform info](#Platform-info)
22-
* [Support](#Support)
23-
* [Hardware support](#Hardware-support)
24-
* [Community support](#Community-support)
25-
* [Professional support](#Professional-support)
17+
* [Quick Start](#quick-start)
18+
* [Details](#details)
19+
* [How to build](#how-to-build)
20+
* [How to operate](#how-to-operate)
21+
* [Platform info](#platform-info)
22+
* [Support](#support)
23+
* [Hardware support](#hardware-support)
24+
* [Community support](#community-support)
25+
* [Professional support](#professional-support)
2626

2727
## Quick Start
2828

@@ -33,11 +33,14 @@ It contains following sections:
3333
* Flash the firmware.
3434
* Copy the downloaded firmware to OpenBMC.
3535
* From OpenBMC
36+
3637
```
3738
fw-util mb --update bios --force ./<firmware image name>
3839
```
40+
3941
* Boot and enjoy.
4042
* From OpenBMC
43+
4144
```
4245
power-util mb reset
4346
sol-util mb
@@ -47,7 +50,7 @@ It contains following sections:
4750
4851
### How to build
4952
50-
Follow [Build Details](#Build-Details) for details on how to get the source
53+
Follow [Build Details](#build-details) for details on how to get the source
5154
code, and how to build.
5255
5356
Boot flow of the current firmware solution is: Power on → minimized UEFI →
@@ -59,15 +62,19 @@ target OS.
5962
#### Build Details
6063
6164
* Download the code from [linuxboot github](https://github.com/linuxboot/linuxboot)
65+
6266
```
6367
git clone https://github.com/linuxboot/linuxboot.git
6468
```
69+
6570
* You need to apply Wiwiynn's linuxboot patch for now
71+
6672
```
6773
cd linuxboot
6874
wget -O TiogaPass.patch https://github.com/johnnylinwiwynn/linuxboot/commit/28ae8450b3b05c6e6b8c74e29d0974ccf711d5e6.patch
6975
git am TiogaPass.patch
7076
```
77+
7178
* Build the kernel bzImage (has embedded initramfs) for linuxboot, please
7279
reference [Building u-root](https://github.com/linuxboot/book/tree/master/coreboot.u-root.systemboot#building-u-root)
7380
and [Building a suitable Linux kernel](https://github.com/linuxboot/book/tree/master/coreboot.u-root.systemboot#building-a-suitable-linux-kernel)
@@ -77,12 +84,14 @@ target OS.
7784
* Place the tioga.rom into linuxboot/boards/tioga which is provided from Wiwynn
7885
after ordering, and also put your bzImage to the root folder of linuxboot,
7986
and then make
87+
8088
```
8189
cp path/to/tioga.rom linuxboot/boards/tioga
8290
cp path/to/bzImage linuxboot
8391
cd linuxboot
8492
BOARD=tioga make
8593
```
94+
8695
* You should see the built image at build/tioga/linuxboot.rom.
8796
8897
### How to operate
@@ -122,4 +131,4 @@ IRC channel, a mailing list and regular meetings.
122131
123132
Following companies provides professional support services:
124133
125-
** TBD **
134+
**TBD**

src/coreboot.u-root.systemboot/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ path with `-o`. Run `u-root -h` for additional command line parameters.
7878
Note: the above command will include only pure-Go commands from `u-root`. If
7979
you need to include other files or non-Go binaries, use the `-file` option in
8080
`u-root`. For example, you may want to include static builds of `kexec` or
81-
`flashrom`, that we build on https://github.com/systemboot/binaries .
81+
`flashrom`, that we build on <https://github.com/systemboot/binaries> .
8282

8383
Then, the initramfs has to be compressed. This step is necessary to embed the
8484
initramfs in the kernel as explained below, in order to maintain the image size
@@ -143,7 +143,7 @@ make tinyconfig
143143
```
144144

145145
Some more information about tiny configs can be found at
146-
https://tiny.wiki.kernel.org (last checked 2018-12-01).
146+
<https://tiny.wiki.kernel.org> (last checked 2018-12-01).
147147

148148
### A few fundamental features
149149

@@ -184,7 +184,7 @@ In menuconfig:
184184
&rarr; `Enable eventpoll support`
185185

186186
Additional information about Go's minimum requirements can be found at
187-
https://github.com/golang/go/wiki/MinimumRequirements (last checked
187+
<https://github.com/golang/go/wiki/MinimumRequirements> (last checked
188188
2018-12-01).
189189

190190
### Enable devtmpfs
@@ -302,7 +302,7 @@ The image will be located under `arch/${ARCH}/boot/bzImage` if your
302302
architecture supports bzImage (e.g. x86).
303303

304304
For more details on how to build a kernel, see
305-
https://kernelnewbies.org/KernelBuild (last checked 2018-12-01).
305+
<https://kernelnewbies.org/KernelBuild> (last checked 2018-12-01).
306306

307307
## Building coreboot
308308

src/intro.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,19 @@ be used as a recovery environment.
2929

3030
Many other implementations exist independently of the project:
3131

32-
- [petitboot](https://github.com/open-power/petitboot) under the OpenPOWER
32+
* [petitboot](https://github.com/open-power/petitboot) under the OpenPOWER
3333
project originally targeting the PS3
34-
- [k-boot](https://github.com/BayLibre/k-boot) developed by BayLibre in 2023
34+
* [k-boot](https://github.com/BayLibre/k-boot) developed by BayLibre in 2023
3535
using BusyBox
36-
- [nmbl](https://github.com/rhboot/nmbl-poc) developed by RedHat in 2024
37-
- [ZFSBootMenu](https://docs.zfsbootmenu.org/en/latest)
36+
* [nmbl](https://github.com/rhboot/nmbl-poc) developed by RedHat in 2024
37+
* [ZFSBootMenu](https://docs.zfsbootmenu.org/en/latest)
3838

3939
And there is a long history of similar implementations including projects that
4040
are no longer maintained:
4141

42-
- MILO on Alpha started before 2000 (see [What is
42+
* MILO on Alpha started before 2000 (see [What is
4343
MILO?](https://tldp.org/HOWTO/MILO-HOWTO/what-section.html))
44-
- kboot developed by Werner Almesberger in 2005
44+
* kboot developed by Werner Almesberger in 2005
4545

4646
These projects all attempt to reduce the role of firmware to a small,
4747
fixed-function core whose only purpose is to get a flash-based Linux kernel
@@ -91,7 +91,7 @@ Reliability
9191
hardened Linux drivers
9292
* Proven approach for almost 20 years in military, consumer electronics, and
9393
supercomputers – wherever reliability and performance are paramount
94-
* Fault Tolerance - Linux isolates processes** **(for example, when `pxeboot`
94+
* Fault Tolerance - Linux isolates processes****(for example, when `pxeboot`
9595
fails catastrophically, `diskboot` still works afterwards)
9696

9797
Security

src/utilities/UEFI_Tool_Kit.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -422,8 +422,8 @@ Visitor pattern means decoupling the structure from the operations.
422422

423423
Good resources:
424424

425-
1. https://sourcemaking.com/design_patterns/visitor
426-
2. https://en.wikipedia.org/wiki/Visitor_pattern
425+
1. <https://sourcemaking.com/design_patterns/visitor>
426+
2. <https://en.wikipedia.org/wiki/Visitor_pattern>
427427

428428
A good visitor still works when new Firmware are introduced. A good Firmware
429429
still works when a new visitor is introduced.

src/utilities/cpu.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -574,7 +574,7 @@ Even though the binaries themselves are running on the remote ARM system.
574574
575575
#### cpu and virtiofs
576576
577-
While 9p is very general, because it is *transport-independent*, there are
577+
While 9p is very general, because it is _transport-independent_, there are
578578
cases where we can get much better performance by using a less general file
579579
system. One such case is with virtofs.
580580
@@ -633,7 +633,7 @@ There are thus several choices for setting up the mounts
633633
634634
* 9p support by the cpu client
635635
* 9p supported by the cpu client, with additional mounts via -fstab or -namespace
636-
* 9p *without* any bind mounts, i.e. -9p=false -namespace "", in which case, on
636+
* 9p _without_ any bind mounts, i.e. -9p=false -namespace "", in which case, on
637637
the remote machine, files from the client are visible in /tmp/cpu, but no
638638
bind mounts are done; with additional mounts provided by fstab
639639
mounts are provided

src/utilities/dut.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# DUT, a simple Device Under Test utility.
1+
# DUT, a simple Device Under Test utility
22

33
Points of contact: [Ron Minnich](https://github.com/rminnich)
44

@@ -19,6 +19,7 @@ This chapter describes how we build and use DUT.
1919
## Components
2020

2121
DUT is intended to be built into a u-root image. First one must fetch it:
22+
2223
```
2324
go get github.com/linuxboot/dut
2425
# ignore the warning message.
@@ -27,31 +28,37 @@ go get github.com/linuxboot/dut
2728
DUT source tree is structured such that a program called uinit is produced. This is convenient for u-root usage.
2829

2930
Building it into a u-root image is easy:
31+
3032
```
3133
go run $(GOPATH)/src/github.com/u-root/u-root -build=bb minimal github.com/linuxboot/dut/uinit
3234
```
3335

3436
I almost always add an sshd to u-root; it's just too handy. U-root sshd does not support
3537
passwords, so you have to supply the public key:
38+
3639
```
3740
go run $(GOPATH)/src/github.com/u-root/u-root -build=bb -files key.pub minimal github.com/linuxboot/dut/uinit github.com/u-root/u-root/xcmds/sshd
3841
```
3942

4043
### DUT on the device
44+
4145
On boot, the standard init program will find dut, and run it. The standard mode on a device
4246
is device mode, and dut will bring up the ethernet, currently
4347
using 192.168.0.2, and assuming the tester is 192.168.0.1 (this should be fixed ...).
4448
It will then attempt to connect to a uinit running in 'tester' mode on 192.168.0.1. Once connected, it functions
4549
as a server and waits for requests.
4650

4751
### DUT on the controller
52+
4853
Running on the controller is easy:
54+
4955
```
5056
uinit -m tester
5157
```
5258

5359
On the controller, the program waits for a connection and then starts issuing commands to the device.
5460
The controller has the option of calling the following RPC functions:
61+
5562
```
5663
RPCWelcome - return a welcome message
5764
RPCExit - exit the testing mode
@@ -61,6 +68,7 @@ RPCSsh - start the sshd
6168
```
6269

6370
Each of these RPCs takes arguments and returns a result, with Welcome being the most fun:
71+
6472
```
6573
______________
6674
< welcome to DUT >

0 commit comments

Comments
 (0)