Skip to content

Commit 7e5835e

Browse files
committed
docs(build): update build instructions
Update build instructions for the new build process now that we skip the config step. Signed-off-by: Randolph Sapp <[email protected]>
1 parent 4554ce1 commit 7e5835e

File tree

1 file changed

+33
-51
lines changed

1 file changed

+33
-51
lines changed

README.md

Lines changed: 33 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -19,72 +19,54 @@ OR you can use a docker container like the following:
1919

2020
### Build on Ubuntu
2121

22-
#### Build linux documentatin
22+
To build the documentation a DEVFAMILY and OS must be specified as either an
23+
argument to `make` or set as environment variables prior to execution of `make`.
2324

24-
$ make clean DEVFAMILY=<FAMILY> OS=linux
25-
$ make config DEVFAMILY=<FAMILY> OS=linux
26-
$ make DEVFAMILY=<FAMILY> OS=linux
25+
DEVFAMILY represents the Device Family. Possible values correspond to the names
26+
of directories listed under `configs/`. For example:
2727

28-
#### Build rtos documentation
28+
* "AM335X" (representing AM335X family)
29+
* "AM437X" (representing AM437X family)
30+
* "AM57X" (representing AM57X family)
31+
* "AM64X" (representing AM64X family)
32+
* "AM62X" (representing AM62X family)
33+
* "AM62AX" (representing AM62AX family)
34+
* "AM62PX" (representing AM62PX family)
35+
* "AM65X" (representing AM65X family)
36+
* "DRA821A" (representing DRA821A)
37+
* "J721E" (representing Jacinto 7 ES)
38+
* "J7200" (representing Jacinto 7 VCL)
39+
* "J721S2" (representing Jacinto 7 AEP)
40+
* "J784S4" (representing Jacinto 7 AHP)
41+
* "J722S" (representing Jacinto 7 AEN)
42+
* "GEN" (representing General family not listed above)
43+
* "CORESDK" (representing CORESDK)
2944

30-
$ make clean DEVFAMILY=<FAMILY> OS=rtos
31-
$ make config DEVFAMILY=<FAMILY> OS=rtos
32-
$ make DEVFAMILY=<FAMILY> OS=rtos
45+
OS represents the operating system. Possible values correspond to the second
46+
parameter of files listed under the `configs/<DEVFAMILY>/` directory. For
47+
example `AM57X_linux_toc.txt` means that `linux` is a valid OS value.
3348

34-
#### Build android (available for J721E and GEN):
49+
Example build commands:
3550

36-
$ make clean DEVFAMILY=<FAMILY> OS=android
37-
$ make config DEVFAMILY=<FAMILY> OS=android
38-
$ make DEVFAMILY=<FAMILY> OS=android
51+
- Build linux documentation for AM335X
3952

40-
### Build am64x documentation
53+
$ make DEVFAMILY=AM335X OS=linux
4154

42-
$ make config DEVFAMILY=AM64X
43-
$ make DEVFAMILY=AM64X
55+
- Build rtos documentation AM57X
4456

57+
$ make DEVFAMILY=AM57X OS=rtos
4558

46-
**Note**: that DEVFAMILY represents the Device Family.
47-
Possible values for <FAMILY> are
59+
- Build android documentation for AM62X
4860

49-
* "AM335X" (representing AM335X family)
50-
* "AM437X" (representing AM437X family)
51-
* "AM57X" (representing AM57X family)
52-
* "AM64X" (representing AM64X family)
53-
* "AM62X" (representing AM62X family)
54-
* "AM62AX" (representing AM62AX family)
55-
* "AM62PX" (representing AM62PX family)
56-
* "AM65X" (representing AM65X family)
57-
* "DRA821A" (representing DRA821A)
58-
* "J721E" (representing Jacinto 7 ES)
59-
* "J7200" (representing Jacinto 7 VCL)
60-
* "J721S2" (representing Jacinto 7 AEP)
61-
* "J784S4" (representing Jacinto 7 AHP)
62-
* "J722S" (representing Jacinto 7 AEN)
63-
* "GEN" (representing General family not listed above)
64-
* "CORESDK" (representing CORESDK)
65-
66-
**Note**: Please use script `bin/check-warn.sh` or the `make lint` target
67-
to check for new build warnings and fix them before submitting
68-
pull-requests.
61+
$ make DEVFAMILY=AM62X OS=android
6962

7063
### HTML Page Output
7164

7265
Open the index page in a web browser
7366

74-
**AM64X**:
75-
76-
./build/processor-sdk-AM64X/esd/docs/[version]/index.html
77-
78-
**GEN family** (TODO: to be migrated to the new structure):
79-
80-
linux: ./build/processor-sdk-linux/esd/docs/[version]/index.html
81-
rtos: ./build/processor-sdk-rtos/esd/docs/[version]/index.html
82-
android: ./build/processor-sdk-android/esd/docs/[version]/index.html
83-
84-
**Others**:
85-
86-
linux: ./build/processor-sdk-linux-<FAMILY>/esd/docs/[version]/index.html
87-
rtos: ./build/processor-sdk-rtos-<FAMILY>/esd/docs/[version]/index.html
67+
linux: ./build/processor-sdk-linux-<FAMILY>/esd/docs/[version]/index.html
68+
rtos: ./build/processor-sdk-rtos-<FAMILY>/esd/docs/[version]/index.html
69+
android: ./build/processor-sdk-android-<FAMILY>/esd/docs/[version]/index.html
8870

8971
## Tips and Tricks
9072

0 commit comments

Comments
 (0)