Skip to content

Commit a6a9427

Browse files
authored
[docs] Correct clone instructions & typos (sonic-net#12733)
[docs] Correct clone instructions & typos Remove the git 1.9 reference, as it has been out since Feb 2014 at this point.
1 parent dc21c96 commit a6a9427

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

README.buildsystem.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ You might find **rules/config** very useful, as it is a configuration file for a
5555
**dockers/** directory is a place where you can find Dockerfiles for generic docker images.
5656
**src/** is a place where a source code for generic packages goes.
5757
It has both submodules (simple case, just run dpkg-buildpackage to build),
58-
and directories with more complcated components, that provide their own Makefiles.
58+
and directories with more complicated components, that provide their own Makefiles.
5959
**platform/** contains all vendor-specific recipes, submodules etc.
6060
Every **platform/[VENDOR]/** directory is a derived part of buildimage frontend, that defines rules and targets for a concrete vendor.
6161

@@ -119,7 +119,7 @@ SONIC_PYTHON_STDEB_DEBS += $(SOME_NEW_DEB) # add package to this target group
119119
120120
**SONIC_MAKE_DEBS**
121121
This is a bit more flexible case.
122-
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.
122+
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.
123123
Define:
124124
```make
125125
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
178178
```
179179
180180
**SONIC_DOCKER_IMAGES**
181-
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.
181+
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.
182182
Define:
183183
```make
184184
SOME_DOCKER = some_docker.gz # name of your docker

README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -102,10 +102,11 @@ sudo pip3 install j2cli
102102
* Add current user to the docker group: `sudo gpasswd -a ${USER} docker`
103103
* Log out and log back in so that your group membership is re-evaluated
104104

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

108-
git clone https://github.com/sonic-net/sonic-buildimage.git
107+
To clone the code repository recursively:
108+
109+
git clone --recurse-submodules https://github.com/sonic-net/sonic-buildimage.git
109110

110111
## Usage
111112

0 commit comments

Comments
 (0)