Skip to content

Commit

Permalink
Docs: git pull is needed after syncing git modules (project-chip#29299)
Browse files Browse the repository at this point in the history
* git pull is needed after syncing git modules

I followed the instructions to update the repo but still wondered why it dit not really do anything. Now I stumbled the secod time over the fact that tthe "clone" command in docs give you a full working repo, but the "synching modules" does not update them ... so git pull is needed.

I think it nmight be good to add that here in order to support users.

* Update BUILDING.md

* Update docs/guides/BUILDING.md

Co-authored-by: Boris Zbarsky <bzbarsky@apple.com>

* Restyled by prettier-markdown

---------

Co-authored-by: Boris Zbarsky <bzbarsky@apple.com>
Co-authored-by: Restyled.io <commits@restyled.io>
  • Loading branch information
3 people authored Sep 22, 2023
1 parent 09bb8d2 commit a38af8b
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/guides/BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,13 @@ To check out the Matter repository, run the following command:
git clone --recurse-submodules git@github.com:project-chip/connectedhomeip.git
```

## Synchronizing submodules
## Updating Matter code

If you already have the Matter code checked out, run the following command to
synchronize submodules:
If you already have the Matter code checked out, run the following commands to
update the repository and synchronize submodules:

```
git pull
git submodule update --init
```

Expand Down

0 comments on commit a38af8b

Please sign in to comment.