Skip to content

docs: add BigLinux installation notes#1798

Open
coldrenatinho wants to merge 3 commits into
HyDE-Project:devfrom
coldrenatinho:docs/biglinux-install-notes
Open

docs: add BigLinux installation notes#1798
coldrenatinho wants to merge 3 commits into
HyDE-Project:devfrom
coldrenatinho:docs/biglinux-install-notes

Conversation

@coldrenatinho

@coldrenatinho coldrenatinho commented Jun 27, 2026

Copy link
Copy Markdown

Description

  • add BigLinux / Manjaro installation notes to the main README
  • add the same guidance to the pt-BR README
  • document snapshot, NVIDIA legacy-driver, and post-install session-selection reminders

This is intended to make HyDE easier to adopt on Arch-based distros that often ship with an existing desktop setup.

Type of change

  • Documentation update (non-breaking change; modified files are limited to the documentations)

Checklist

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My commit message follows the commit guidelines.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added a changelog entry.
  • I have added necessary comments/documentation to my code.
  • I have added tests to cover my changes.
  • I have tested my code locally and it works as expected.
  • All new and existing tests passed.

Additional context

The new notes are intentionally documentation-only so they are easier to review and do not change installer behavior for other Arch-based distributions.

Summary by CodeRabbit

  • New Features

    • Added a window behavior rule so the Ghidra project manager opens as a floating window.
  • Documentation

    • Improved NVIDIA installation guidance, including DKMS auto-detection, legacy driver checks, and clearer expectations for module builds.
    • Added a quick checklist for Arch-based distros and a BigLinux/Manjaro tip to create a Timeshift snapshot beforehand.
    • Updated the same guidance in the Portuguese (Brazil) documentation.
  • Bug Fixes

    • Refined the installer’s shell-change behavior for dry-run mode and now warns while continuing if the shell update fails.

Yuzuru10 and others added 2 commits May 26, 2026 23:00
* made ghidra project manager to float

* Change Ghidra window rule to float true

---------

Co-authored-by: Khing <53417443+kRHYME7@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 27, 2026 17:28

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@coderabbitai

coderabbitai Bot commented Jun 27, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Adds a Hyprland rule to float Ghidra’s project manager window, updates NVIDIA installation guidance in English and Portuguese docs, and makes the restore script’s shell-change step skip dry-run mode and warn on chsh failure.

Changes

Ghidra Float Windowrule

Layer / File(s) Summary
Ghidra float windowrule
Configs/.config/hypr/windowrules.conf
Adds a windowrule that floats windows whose initial_title matches Ghidra: NO ACTIVE PROJECT.

Installer Guidance Updates

Layer / File(s) Summary
NVIDIA guidance and checklist
README.md, Source/docs/README.pt-br.md
Updates NVIDIA installer guidance, adds a Timeshift tip for BigLinux/Manjaro, and adds Arch-based checklist items for restore points, config changes, legacy driver checks, DKMS builds, and post-install session selection.

Restore Shell Login Step

Layer / File(s) Summary
Dry-run-aware shell change
Scripts/restore_shl.sh
Skips chsh in dry-run mode and logs a warning if the shell change fails before continuing.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • kRHYME7

🐇 I floated Ghidra, light and neat,
And packed the docs with checklist feet.
Dry runs skip shells, warnings ring,
This bunny hops through config spring!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main documentation additions for BigLinux/Manjaro installation notes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@Scripts/restore_shl.sh`:
- Line 96: The dry-run guard in the restore script should quote the flg_DryRun
variable before the numeric test to avoid word-splitting or globbing from
unexpected environment values. Update the conditional around the flg_DryRun
check in the script’s main guard so the shell test evaluates a safely quoted
value while preserving the existing -ne 1 comparison.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f36aff3e-9689-4c87-8402-f704facf9410

📥 Commits

Reviewing files that changed from the base of the PR and between 56fbc32 and 894fdd9.

📒 Files selected for processing (3)
  • README.md
  • Scripts/restore_shl.sh
  • Source/docs/README.pt-br.md
✅ Files skipped from review due to trivial changes (1)
  • Source/docs/README.pt-br.md

Comment thread Scripts/restore_shl.sh
if [[ "$(grep "/${USER}:" /etc/passwd | awk -F '/' '{print $NF}')" != "${myShell}" ]]; then
print_log -sec "SHELL" -stat "change" "shell to ${myShell}..."
[ ${flg_DryRun} -eq 1 ] || chsh -s "$(which "${myShell}")"
if [ ${flg_DryRun} -ne 1 ]; then

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Find other unquoted flg_DryRun numeric tests in shell scripts.
fd -e sh . Scripts Configs | xargs rg -n '\[\s+\$\{?flg_DryRun\}?(\s|])'

Repository: HyDE-Project/HyDE

Length of output: 1882


🏁 Script executed:

#!/bin/bash
set -euo pipefail

# Inspect the relevant section and nearby dry-run checks.
sed -n '85,105p' Scripts/restore_shl.sh

printf '\n---\n'

# Probe how the test behaves with normal, empty, and malformed values.
for v in 0 1 '' '1 2' '*'; do
  printf 'value=%q -> ' "$v"
  if bash -c 'v=$1; if [ $v -ne 1 ]; then echo yes; else echo no; fi' _ "$v" 2>&1; then
    : 
  fi
done

Repository: HyDE-Project/HyDE

Length of output: 1136


Quote flg_DryRun in this guard. Even with the default value earlier, an unexpected environment value can split or glob before [ evaluates the numeric comparison.

Suggested fix
-    if [ ${flg_DryRun} -ne 1 ]; then
+    if [ "${flg_DryRun}" -ne 1 ]; then
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if [ ${flg_DryRun} -ne 1 ]; then
if [ "${flg_DryRun}" -ne 1 ]; then
🧰 Tools
🪛 Shellcheck (0.11.0)

[info] 96-96: Double quote to prevent globbing and word splitting.

(SC2086)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@Scripts/restore_shl.sh` at line 96, The dry-run guard in the restore script
should quote the flg_DryRun variable before the numeric test to avoid
word-splitting or globbing from unexpected environment values. Update the
conditional around the flg_DryRun check in the script’s main guard so the shell
test evaluates a safely quoted value while preserving the existing -ne 1
comparison.

Source: Linters/SAST tools

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants