Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Firmware Framework
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Model registry
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
FPGA Firmware
Firmware Framework
Commits
cc7e6374
Commit
cc7e6374
authored
1 year ago
by
Katharina Schulz
Browse files
Options
Downloads
Patches
Plain Diff
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
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
doc/modules/ROOT/partials/fwk_make_cmd.adoc
+11
-0
11 additions, 0 deletions
doc/modules/ROOT/partials/fwk_make_cmd.adoc
doc/modules/ROOT/partials/git_instructions.adoc
+41
-1
41 additions, 1 deletion
doc/modules/ROOT/partials/git_instructions.adoc
with
52 additions
and
1 deletion
doc/modules/ROOT/partials/fwk_make_cmd.adoc
+
11
−
0
View file @
cc7e6374
...
...
@@ -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[]
...
...
This diff is collapsed.
Click to expand it.
doc/modules/ROOT/partials/git_instructions.adoc
+
41
−
1
View file @
cc7e6374
...
...
@@ -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[]
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment