Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[docs] Correct clone instructions & typos #12733

Merged
merged 2 commits into from
Nov 18, 2022
Merged

[docs] Correct clone instructions & typos #12733

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2006223
[doc] Make git clone instructions download submodules
andrewimeson Nov 17, 2022
6973061
[doc] Fix typos in build system README
andrewimeson Nov 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.buildsystem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ You might find **rules/config** very useful, as it is a configuration file for a
**dockers/** directory is a place where you can find Dockerfiles for generic docker images.
**src/** is a place where a source code for generic packages goes.
It has both submodules (simple case, just run dpkg-buildpackage to build),
and directories with more complcated components, that provide their own Makefiles.
and directories with more complicated components, that provide their own Makefiles.
**platform/** contains all vendor-specific recipes, submodules etc.
Every **platform/[VENDOR]/** directory is a derived part of buildimage frontend, that defines rules and targets for a concrete vendor.

Expand Down Expand Up @@ -119,7 +119,7 @@ SONIC_PYTHON_STDEB_DEBS += $(SOME_NEW_DEB) # add package to this target group

**SONIC_MAKE_DEBS**
This is a bit more flexible case.
If you have to do some specific type of build or apply pathes prior to build, just define your own Makefile and add it to buildimage.
If you have to do some specific type of build or apply paths prior to build, just define your own Makefile and add it to buildimage.
Define:
```make
SOME_NEW_DEB = some_new_deb.deb # name of your package
Expand Down Expand Up @@ -178,7 +178,7 @@ SONIC_SIMPLE_DOCKER_IMAGES += $(SOME_DOCKER) # add docker to this group
```

**SONIC_DOCKER_IMAGES**
This one is a bit more sophisticated. You can define debian packages from buildimage that will be installed to it, and corresponding Dockerfile will be dinamically generated from a template.
This one is a bit more sophisticated. You can define debian packages from buildimage that will be installed to it, and corresponding Dockerfile will be dynamically generated from a template.
Define:
```make
SOME_DOCKER = some_docker.gz # name of your docker
Expand Down
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,11 @@ sudo pip3 install j2cli
* Add current user to the docker group: `sudo gpasswd -a ${USER} docker`
* Log out and log back in so that your group membership is re-evaluated

## Clone or fetch the code repository with all git submodules
To clone the code repository recursively, assuming git version 1.9 or newer:
## Clone the repository with all the git submodules

git clone https://github.com/sonic-net/sonic-buildimage.git
To clone the code repository recursively:

git clone --recurse-submodules https://github.com/sonic-net/sonic-buildimage.git

## Usage

Expand Down