Skip to content

docs/getting-started -document RIP vs install copy behavior in pickconfig#3974

Open
grandixximo wants to merge 1 commit intoLinuxCNC:masterfrom
grandixximo:docs-pickconfig-clarify
Open

docs/getting-started -document RIP vs install copy behavior in pickconfig#3974
grandixximo wants to merge 1 commit intoLinuxCNC:masterfrom
grandixximo:docs-pickconfig-clarify

Conversation

@grandixximo
Copy link
Copy Markdown

Summary

Documents the Configuration Selector copy-on-launch behavior in
docs/src/getting-started/running-linuxcnc.adoc:

  • copy fires on package installs (deb, rpm) where sample configs live
    under a non-writable system path
  • RIP builds run sample configs in place because the source tree is
    writable by the user who built it
  • debug_pickconfig=1 env var forces a copy from a RIP build

Behavior is unchanged since 2006 (commit 03ebae2, "prompt the user
to copy a read-only configuration"); this was previously only
documented in tcl/bin/pickconfig.tcl source comments.

Closes the documentation gap raised in #3924 by @rodw-au.

Test plan

  • asciidoc renders the new sections without errors
  • visual check of rendered output

…nfig

Configuration Selector copies sample configs to ~/linuxcnc/configs
on package installs but runs them in place on RIP builds. This was
documented only in pickconfig.tcl source comments. Add user-facing
notes covering when the copy happens (package install vs RIP) and
the debug_pickconfig=1 override for forcing a copy from a RIP build.

Refs LinuxCNC#3924.
@rodw-au
Copy link
Copy Markdown
Contributor

rodw-au commented Apr 28, 2026

Looks good!

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.

2 participants