Fix Markdown formate for the linter check

This commit is contained in:
Wang, Yanyao
2024-06-05 10:41:25 -07:00
committed by Aakash Sudhanwa
parent 27bd772bbe
commit b7c6671e06
4 changed files with 42 additions and 24 deletions

View File

@@ -62,7 +62,6 @@ Each ROCm component repository contains directions for building that component,
Each release of the ROCm software supports specific hardware and software configurations. Refer to [System requirements (Linux)](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html) for the current supported hardware and OS.
## Build ROCm from source
The Build will use as many processors as it can find to build in parallel. Some of the compiles can consume as much as 10GB of RAM, so make sure you have plenty of Swap Space !
@@ -151,6 +150,7 @@ out/ubuntu-22.04/22.04/logs/rocblas.inprogress # Example
# All logs pertaining to passed components, use the component names.
out/ubuntu-22.04/22.04/logs/rocblas # Example
```
Note: [Overview for ROCm.mk](rocm-build/README.md)
## ROCm documentation

View File

@@ -1,33 +1,37 @@
# Overview for ROCm.mk
This Makefile builds the various projects that makes up ROCm in the correct order.
It is expected to be run in an environment with the tooling set up. An easy way
to do this is to use Docker.
# Targets
- all (default)
- rocm-dev (a subset of all)
- clean
- list_components
- help
- T_foo
- C_foo
## Targets
* all (default)
* rocm-dev (a subset of all)
* clean
* list_components
* help
* T_foo
* C_foo
# Makefile Variables
- PEVAL set to 1 to enable some Makefile debugging code.
- RELEASE\_FLAG set to "" to avoid passing "-r" to builds, effect is package defined.
- NOBUILD="foo bar" to avoid adding foo and bar into the dependencies of top level targets. They still may be
## Makefile Variables
* PEVAL set to 1 to enable some Makefile debugging code.
* RELEASE\_FLAG set to "" to avoid passing "-r" to builds, effect is package defined.
* NOBUILD="foo bar" to avoid adding foo and bar into the dependencies of top level targets. They still may be
built if they are needed as dependencies of other top level targets.
- toplevel
* toplevel
# Makefile assumptions
## Makefile assumptions
## Requirements for package "foo"
### Requirements for package "foo"
### program build\_foo.sh
- Should take option "-c" to clean
- Should take option "-r" to do a normal "RelWithDeb" build
#### program build\_foo.sh
## For package "foo" we define some targets
- T\_foo - The main build target, calls "build\_foo.sh -r"
- C\_foo - Clean target, calls "build_foo.sh -c"
* Should take option "-c" to clean
* Should take option "-r" to do a normal "RelWithDeb" build
### For package "foo" we define some targets
* T\_foo - The main build target, calls "build\_foo.sh -r"
* C\_foo - Clean target, calls "build_foo.sh -c"

View File

@@ -1,20 +1,26 @@
## Steps to build the Docker Image
1. Clone this repositry
```bash
git clone -b roc-6.1.x https://github.com/ROCm/ROCm.git
```
2. Go into the OS specific docker directory in build-infra
```bash
cd ROCm/rocm-build/docker/ubuntu20
```
3. Build the Docker image
```bash
docker build -t <docker Image Name> .
```
replace the `<docker Image Name>` with the new Docker image Name of your choice,
5. After successful build, verify your \<docker Image Name\> in the list all available docker images.
4. After successful build, verify your \<docker Image Name\> in the list all available docker images.
```bash
docker images
```

View File

@@ -1,18 +1,26 @@
## Steps to build the Docker Image
1. Clone this repositry
```bash
git clone -b roc-6.1.x https://github.com/ROCm/ROCm.git
```
2. Go into the OS specific docker directory in build-infra
```bash
cd ROCm/rocm-build/docker/ubuntu22
```
3. Build the docker image
```bash
docker build -t <docker Image Name> .
```
replace the `<docker Image Name>` with the new Docker image Name of your choice,
4. After successful build, verify your \<docker Image Name\> in the list all available docker images.
```bash
docker images
```