Skip to content

Commit

Permalink
[docs] Correct clone instructions & typos (#12733)
Browse files Browse the repository at this point in the history
[docs] Correct clone instructions & typos
Remove the git 1.9 reference, as it has been out since Feb 2014 at this
point.
  • Loading branch information
andrewimeson authored Nov 18, 2022
1 parent dc21c96 commit a6a9427
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.buildsystem.md
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
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

0 comments on commit a6a9427

Please sign in to comment.