Skip to content
Snippets Groups Projects
Commit cc7e6374 authored by Katharina Schulz's avatar Katharina Schulz
Browse files

doc(partials): add git_clone_prj tag to git_instruction.adoc

parent c12cd07d
No related branches found
No related tags found
No related merge requests found
......@@ -16,6 +16,17 @@ make cfg={CFG_NAME} project #<1>
. Loads project properties defined in configuration file and generates the project.
end::make_project[]
tag::make_build[]
ifndef::CFG_NAME[]
:CFG_NAME: default
endif::[]
[source, shell, subs="attributes"]
----
make cfg={CFG_NAME} build #<1>
----
. Builds the generated project based on the configuration and exits tool when it has finished.
end::make_build[]
tag::make_sim[]
[source, shell, subs="attributes"]
ifndef::CFG_NAME[]
......
......@@ -69,4 +69,44 @@ endif::[]
----
git submodule add -b main {SUBMODULE_URL} ./src{SUBMODULE_SRC_PATH}/{SUBMODULE_NAME}
----
end::add_submodule[]
\ No newline at end of file
end::add_submodule[]
tag::git_clone_prj[]
ifndef::PRJ_URL[]
:PRJ_URL: <prj_url>
endif::[]
ifndef::PRJ_DIR[]
:PRJ_DIR: <prj_dir>
endif::[]
[source, shell, subs="attributes"]
----
git clone -b main {PRJ_URL} #<1>
cd {PRJ_DIR}/ #<2>
git submodule update --init -recursive #<3>
----
. Clones {PRJ_ACRONYM} repository to local repository.
. Change to {PRJ_DIR} directory.
. Updates submodule and nested dependencies.
end::git_clone_prj[]
tag::checkout_prj_version[]
ifndef::PRJ_DIR[]
:PRJ_DIR: <prj_dir>
endif::[]
ifndef::PRJ_VERSION[]
:PRJ_VERSION: <x.x.x>
endif::[]
[source, shell, subs="attributes"]
----
cd {PRJ_DIR}/ #<1>
git tag -n #<2>
git checkout {PRJ_VERSION} #<3>
cd ../../.. #<4>
----
tag::annotate[]
. Go to the {PRJ_DIR} folder.
. List all tagged version.
. Checkout the desired tagged version.
. Return to project folder.
end::annotate[]
end::checkout_prj_version[]
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment