diff options
| author | John Nduli | 2024-07-16 19:13:17 +0300 |
|---|---|---|
| committer | SidiBlak | 2024-07-17 08:40:32 -0500 |
| commit | 881a7423a76e6cdd5ec6eca6738612f9197fc337 (patch) | |
| tree | f18ec3176a9a567d7f5cc03c64b574cd30f19d4f /topics | |
| parent | 909c885659761f46efec1bca253637b096ed3929 (diff) | |
| download | gn-gemtext-881a7423a76e6cdd5ec6eca6738612f9197fc337.tar.gz | |
docs: add example for guide preference
Diffstat (limited to 'topics')
| -rw-r--r-- | topics/documentation/guides_vs_references.gmi | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/topics/documentation/guides_vs_references.gmi b/topics/documentation/guides_vs_references.gmi index b507623..e5d2acb 100644 --- a/topics/documentation/guides_vs_references.gmi +++ b/topics/documentation/guides_vs_references.gmi @@ -9,3 +9,15 @@ For guides: * Preferable have another team member review the docs. This helps eliminate blindspots due to our current knowledge. * Organize the document in such a way that it starts with the most actionable steps. * Avoid stream of consciousness writing. + +## Example +### Wrong + +When setting up guix OS, I couldn't get `tmux` to start, getting `tmux: invalid LC_ALL, LC_CTYPE or LANG`. Running `locale -a` failed too. It took me a while to figure out the solution for this problem, and I attempted to reinstall `glibc-locales` which didn't help. After a lot of research, I found that the root cause was that my applications were built on a different version of `glibc`. I ran `guix update` and the problem disappeared. + +### Correct + +`tmux` failing with `tmux: invalid LC_ALL, LC_CTYPE or LANG` could be caused by having packages build on a different version of `glibc`. Attempt: + +> locale -a # should also fail +> guix update # rebuilds your packages with your current glibc |