Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add script for generating setup summary for troubleshooting support #265

Merged
merged 1 commit into from
Sep 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/troubleshooting/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ You can inspect a failing [AliHyperloop test](../hyperloop/userdocumentation.md#

See the [Support](../gettingstarted/support.md) section for the list of Mattermost channels where you can ask for help.

When asking for help with compilation or with running a local analysis, it may be useful to provide basic information about your O2Physics setup.
You can generate it by running the [`summarise_o2p_setup.sh`](summarise_o2p_setup.sh) bash script in your `alice` directory.

When posting on Mattermost:

- Do not paste the entire content of files or any long blocks of log lines or code directly in the message. If needed, attach the file.
Expand Down
22 changes: 22 additions & 0 deletions docs/troubleshooting/summarise_o2p_setup.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
#!/bin/bash

# Summarise O2Physics setup

if [[ -n "$(which aliBuild)" ]]; then
echo "aliBuild location: $(which aliBuild)"
# echo "all aliBuild locations: $(whereis aliBuild)"
aliBuild version
else
echo "aliBuild not found."
fi

for repo in alidist O2 O2Physics; do
[[ -d "${repo}" ]] || { echo "Directory ${repo} not found."; continue; }
echo "Last commit of ${repo}: $(cd "${repo}" && git log -n 1 --pretty="format:%ci %h")"
done

for pkg in O2 O2Physics; do
log="$ALIBUILD_WORK_DIR/BUILD/${pkg}-latest/log"
[[ -f "${log}" ]] || { echo "Log file ${log} not found."; continue; }
echo "Last build of ${pkg}: $(stat -c "%y" "${log}")"
done
Loading