Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Axii
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD 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
Software
ArmarX
Meta
Axii
Commits
6e6f8b4a
Commit
6e6f8b4a
authored
3 months ago
by
Christian Dreher
Browse files
Options
Downloads
Patches
Plain Diff
docs: Provide more information on Axii troubleshooting
parent
31e282f3
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Pipeline
#22359
passed with warnings
3 months ago
Stage: lint
Stage: test
Stage: deploy
Stage: post-deploy-test
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/advanced_users/README.md
+22
-13
22 additions, 13 deletions
docs/advanced_users/README.md
with
22 additions
and
13 deletions
docs/advanced_users/README.md
+
22
−
13
View file @
6e6f8b4a
...
...
@@ -198,7 +198,7 @@ axii workspace git status
```
## Troubleshooting Workspace Upgrades
## Troubleshooting
Guide for
Workspace Upgrades
Axii cannot guarantee that upgrades will always succeed, especially if partial upgrades or manual
`prepare`
s or
`build`
s are performed for time saving reasons. However, Axii gives you i) all
...
...
@@ -206,32 +206,41 @@ necessary information to debug the problems yourselves and ii) tools and command
The necessary information is provided by Axii printing the full commands with all arguments, as
well as the complete output of these commands for you to inspect, copy & paste and run yourself,
fiddle around with it, and eventually incorporate any necessary changes into the module
definitions
. The necessary tools are provided by several subcommands of Axii which will b
e
elaborated in the following.
definitions
and provide the changes for everyone to benefit from it. The necessary tools ar
e
provided by several subcommands of Axii which will be
elaborated in the following.
The best general troubleshooting routine (in order of least time consuming to "it's home time!")
proved to be the following. After each step, you may try it again. If it still doesn't successfully
upgrade, proceed with the next step.
-
Verify the integrity of your workspace with
`axii workspace verify`
; follow the orders to
1.
Make sure you are on the Axii stable release branch:
`axii self change-release stable`
2.
Make sure that Axii is up-to-date:
`axii self update`
3.
Verify the integrity of your workspace with
`axii workspace verify`
; follow the orders to
fix potential issues and try it again with a full
`axii workspace upgrade`
.
-
Especially if there are any stray modules Axii is not actively maintaining anymore it might
become dangerous, since these might still be found via CMake, and producing compile errors or
segmentation faults if not built correctly.
-
Clean the modules
`build`
folder (
`axii workspace clean -tn`
in the failing module in your
-
Especially if there are any stray modules Axii is not actively maintaining anymore it might
become dangerous, since these might still be found via CMake, and producing compile errors or
segmentation faults if not built correctly.
4.
Clean the modules
`build`
folder (
`axii workspace clean -tn`
in the failing module in your
workspace) or Python
`.venv`
folder (by deleting it manually), depending on the concrete problem.
You can try it again with a local
`axii workspace upgrade -tn`
or a full
`axii workspace upgrade`
if need be.
-
**Beware of data loss**
Delete the whole module in your workspace and set it up again with a full
5.
**Beware of data loss**
Delete the whole module in your workspace and set it up again with a full
`axii workspace upgrade`
.
-
Uncommitted / unpushed changes will be lost, so push them before doing that.
-
Clean all build artefacts in the whole workspace with
`axii workspace clean`
and try a full clean
6.
Clean all build artefacts in the whole workspace with
`axii workspace clean`
and try a full clean
build again with
`axii workspace upgrade`
.
-
Set up a new temporary workspace with
`axii workspace create`
and test it again there.
7.
Set up a new temporary workspace with
`axii workspace create`
and test it again there.
If the problem still persists, it is very likely not a temporary problem or misconfiguration resulting
from partial upgrades or similar, and you really need to study and understand the problem to fix it
in the module's definition.
from partial upgrades or similar. What you can still do:
-
Check Axii's
[
issue board
](
https://git.h2t.iar.kit.edu/sw/armarx/meta/axii/-/issues
)
if the issue
has already been reported
-
[
Open a new issue
](
https://git.h2t.iar.kit.edu/sw/armarx/meta/axii/-/issues/new
)
and use a
corresponding issue template to provide all necessary information
-
Maybe the issue was already fixed on Axii's development branch
`main`
. Change to Axii's development
branch using
`axii self change-release main`
and start again from step 2. above.
-
Dive into the problem, study and understand it, and try to fix the problematic module definition.
Open a merge request to share fixes with the whole team.
## Building and Upgrading Workspaces
...
...
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