diff mbox series

doc: add `--recurse-submodules` when cloning the repo

Message ID 20240823083720.1545566-1-jingyisong@hust.edu.cn
State Accepted
Headers show
Series doc: add `--recurse-submodules` when cloning the repo | expand

Commit Message

Jingyi Song Aug. 23, 2024, 8:37 a.m. UTC
User could run syscalls testing suite with
`./kirk -f ltp -r syscalls`,
but they may not be aware of the submodule `kirk`.
So I add the `--recurse-submodules` option.

Signed-off-by: Jingyi Song <jingyisong@hust.edu.cn>
---
 doc/users/quick_start.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Cyril Hrubis Aug. 26, 2024, 11:28 a.m. UTC | #1
Hi!
> User could run syscalls testing suite with
> `./kirk -f ltp -r syscalls`,
> but they may not be aware of the submodule `kirk`.
> So I add the `--recurse-submodules` option.

Sounds good to me, we do have a few sumbodules already and it makes
sense to pull them with the initial clone.

Reviewed-by: Cyril Hrubis <chrubis@suse.cz>
Petr Vorel Aug. 30, 2024, 1:16 p.m. UTC | #2
Hi all,

> Hi!
> > User could run syscalls testing suite with
> > `./kirk -f ltp -r syscalls`,
> > but they may not be aware of the submodule `kirk`.
> > So I add the `--recurse-submodules` option.

thanks, merged!

Kind regards,
Petr
diff mbox series

Patch

diff --git a/doc/users/quick_start.rst b/doc/users/quick_start.rst
index 4a48745be..1581b1f0c 100644
--- a/doc/users/quick_start.rst
+++ b/doc/users/quick_start.rst
@@ -17,7 +17,7 @@  Basics requirements to build LTP are the following:
 
 .. code-block:: console
 
-   $ git clone https://github.com/linux-test-project/ltp.git
+   $ git clone --recurse-submodules https://github.com/linux-test-project/ltp.git
    $ cd ltp
    $ make autotools
    $ ./configure