matthew/sonic-buildimage
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

[docs] Correct clone instructions & typos (#12733)

Browse Source 
[docs] Correct clone instructions & typos
Remove the git 1.9 reference, as it has been out since Feb 2014 at this
point.
This commit is contained in:
Andrew Imeson 2022-11-18 02:00:16 -05:00 committed by GitHub
parent dc21c9605e
commit a6a9427215
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.buildsystem.md
View File

@ -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. **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. **src/** is a place where a source code for generic packages goes.
It has both submodules (simple case, just run dpkg-buildpackage to build), 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. **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. Every **platform/[VENDOR]/** directory is a derived part of buildimage frontend, that defines rules and targets for a concrete vendor.
@ -119,7 +119,7 @@ SONIC_PYTHON_STDEB_DEBS += $(SOME_NEW_DEB) # add package to this target group
**SONIC_MAKE_DEBS** **SONIC_MAKE_DEBS**
This is a bit more flexible case. 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: Define:
```make ```make
SOME_NEW_DEB = some_new_deb.deb # name of your package SOME_NEW_DEB = some_new_deb.deb # name of your package
@ -178,7 +178,7 @@ SONIC_SIMPLE_DOCKER_IMAGES += $(SOME_DOCKER) # add docker to this group
``` ```
**SONIC_DOCKER_IMAGES** **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: Define:
```make ```make
SOME_DOCKER = some_docker.gz # name of your docker SOME_DOCKER = some_docker.gz # name of your docker

7
README.md
View File

@ -102,10 +102,11 @@ sudo pip3 install j2cli
* Add current user to the docker group: `sudo gpasswd -a ${USER} docker` * 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 * Log out and log back in so that your group membership is re-evaluated
## Clone or fetch the code repository with all git submodules ## Clone the repository with all the git submodules
To clone the code repository recursively, assuming git version 1.9 or newer:
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 ## Usage