Skip to content

[OT-DOCS] border router build updates#203

Open
jrhodie wants to merge 2 commits into
openthread:mainfrom
jrhodie:main
Open

[OT-DOCS] border router build updates#203
jrhodie wants to merge 2 commits into
openthread:mainfrom
jrhodie:main

Conversation

@jrhodie

@jrhodie jrhodie commented Jun 23, 2026

Copy link
Copy Markdown
Collaborator

No description provided.

@jrhodie jrhodie requested review from Vyrastas and jwhui June 23, 2026 20:43

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the OTBR build documentation to clone the repository recursively. The reviewer suggests retaining the --depth=1 flag alongside --recursive to perform a shallow clone, preventing slow and resource-intensive downloads of the entire commit history.

1. Clone the OTBR repository:
```
$ git clone --depth=1 https://github.com/openthread/ot-br-posix
$ git clone --recursive https://github.com/openthread/ot-br-posix

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Cloning the repository recursively without --depth=1 will download the entire commit history of the repository and all of its submodules, which can be very slow and resource-intensive. It is recommended to keep --depth=1 to perform a shallow clone for faster downloads.

Suggested change
$ git clone --recursive https://github.com/openthread/ot-br-posix
$ git clone --recursive --depth=1 https://github.com/openthread/ot-br-posix

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this suggestion makes sense, @jrhodie please make the update here and in the other file

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


```
$ git clone --depth=1 https://github.com/openthread/ot-br-posix
$ git clone --recursive https://github.com/openthread/ot-br-posix

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Cloning the repository recursively without --depth=1 will download the entire commit history of the repository and all of its submodules, which can be very slow and resource-intensive. It is recommended to keep --depth=1 to perform a shallow clone for faster downloads.

Suggested change
$ git clone --recursive https://github.com/openthread/ot-br-posix
$ git clone --recursive --depth=1 https://github.com/openthread/ot-br-posix

1. Clone the OTBR repository:
```
$ git clone --depth=1 https://github.com/openthread/ot-br-posix
$ git clone --recursive https://github.com/openthread/ot-br-posix

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this suggestion makes sense, @jrhodie please make the update here and in the other file

@jrhodie jrhodie requested a review from Vyrastas June 24, 2026 00:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants