search

ngscopeclient / scopehal-docs

End user documentation for libscopehal
BSD 3-Clause "New" or "Revised" License
11 stars 42 forks source link

Documentation: Ubuntu and Debian HTML pages have double line breaks so apt-get install x \ ... (next line) is treated as a new command, which fails #87

Open Johnsel opened 2 months ago

Johnsel commented 2 months ago

Copied from https://www.ngscopeclient.org/manual/GettingStarted.html

johnsimons@john-ubuntu2404-scopehal:~$ sudo apt install build-essential git cmake pkgconf libgtkmm-3.0-dev \ 
libcairomm-1.0-dev libsigc++-2.0-dev libyaml-cpp-dev catch2 libglfw3-dev curl xzip 
[sudo] password for johnsimons: 
Reading package lists... Done
Building dependency tree... Done
Reading state information... Done
E: Unable to locate package  
libcairomm-1.0-dev: command not found

If you look closely in a text program you will see that tex sneakily prefixed the \ with a \LF and postfixed it with another \LF thus putting the libcairomm-1.0-dev on a new line and breaking the multiline apt-get. This issue is also present for Debian, and possibly other (all?) OS'

Johnsel commented 2 months ago

It worked fine for Fedora 40 using Firefox (which I used on all platforms)

Scratch that.

liveuser@localhost-live:~$ sudo dnf install git gcc g++ cmake make pkgconf cairomm-devel gtk3-devel \ 
libsigc++30-devel yaml-cpp-devel catch-devel glfw-devel 
Fedora 40 - x86_64                              4.3 MB/s |  20 MB     00:04    
Fedora 40 openh264 (From Cisco) - x86_64        945  B/s | 1.4 kB     00:01    
Fedora 40 - x86_64 - Updates                     11 MB/s | 9.9 MB     00:00    
Package git-2.44.0-1.fc40.x86_64 is already installed.
Package pkgconf-2.1.0-1.fc40.x86_64 is already installed.
No match for argument:  
Error: Unable to find a match:  
bash: libsigc++30-devel: command not found...
cdwijs commented 4 weeks ago

Section 3.3 (Windows) Step 4. (Install Vulkan dependencies) is also affected: pacman -S mingw-w64-ucrt-x86_64-vulkan-headers mingw-w64-ucrt-x86_64-vulkan-loader mingw-w64-ucrt-x86_64-shaderc \ mingw-w64-ucrt-x86_64-glslang mingw-w64-ucrt-x86_64-spirv-tools

Resulting error in Msys: cedric@DESKTOP-LRFL83R UCRT64 ~ $ pacman -S mingw-w64-ucrt-x86_64-vulkan-headers mingw-w64-ucrt-x86_64-vulkan-loader mingw-w64-ucrt-x86_64-shaderc \ mingw-w64-ucrt-x86_64-glslang mingw-w64-ucrt-x86_64-spirv-tools error: target not found: -bash: mingw-w64-ucrt-x86_64-glslang: command not found

Copying and pasting both lines separate does work correctly: cedric@DESKTOP-LRFL83R UCRT64 ~ $ pacman -S mingw-w64-ucrt-x86_64-vulkan-headers mingw-w64-ucrt-x86_64-vulkan-loader mingw-w64-ucrt-x86_64-shaderc mingw-w64-ucrt-x86_64-glslang mingw-w64-ucrt-x86_64-spirv-tools resolving dependencies... looking for conflicting packages...

Packages (5) mingw-w64-ucrt-x86_64-glslang-14.3.0-1 mingw-w64-ucrt-x86_64-shaderc-2024.1-1 mingw-w64-ucrt-x86_64-spirv-tools-3~1.3.290.0-1 mingw-w64-ucrt-x86_64-vulkan-headers-1.3.290.0-1 mingw-w64-ucrt-x86_64-vulkan-loader-1.3.290.0-1

Total Download Size: 9.65 MiB Total Installed Size: 90.13 MiB

:: Proceed with installation? [Y/n]