Skip to content

Update readme and fix python tests #238

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.

Sign up for GitHub

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

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open

Update readme and fix python tests #238

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
1631a9f
rename README.rst --> README.md
ElectricRCAircraftGuy Dec 23, 2020
006b1fa
Convert README.md from Restructured Text to Github Flavored Markdown …
ElectricRCAircraftGuy Dec 23, 2020
dc950df
README.md: fix up all parts except for "Installation" section
ElectricRCAircraftGuy Dec 23, 2020
3a7bc12
Update README
ElectricRCAircraftGuy Dec 23, 2020
f594fc2
README.md: fix links
ElectricRCAircraftGuy Dec 23, 2020
ca7d695
README.md: wip: rewriting build and install instructions
ElectricRCAircraftGuy Dec 23, 2020
865c92f
Finish build and install notes in README.md; fix error msg in test_ss…
ElectricRCAircraftGuy Dec 23, 2020
954fc37
README.md: update keygen notes & version output
ElectricRCAircraftGuy Dec 23, 2020
bb51c78
Update README
ElectricRCAircraftGuy Dec 23, 2020
a1d58ae
Fix deprecated warning in conftest.py
ElectricRCAircraftGuy Dec 23, 2020
03ee1f8
pytest.ini: fix test warning
ElectricRCAircraftGuy Dec 23, 2020
56b6763
Add sample test output
ElectricRCAircraftGuy Dec 23, 2020
a91d12f
Update test/README.md
ElectricRCAircraftGuy Dec 23, 2020
ab21324
Update link in test/README.md
ElectricRCAircraftGuy Dec 23, 2020
f923cd0
README.md: address a few comments; do a few improvements
ElectricRCAircraftGuy Dec 23, 2020
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
Prev Previous commit
README.md: address a few comments; do a few improvements
  • Loading branch information
@ElectricRCAircraftGuy
ElectricRCAircraftGuy committed Dec 23, 2020
commit f923cd0685b43eddd40333c7ef2ca066da2f06f4
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,9 @@ umount ~/mnt/sshfs
1. It is recommended to run SSHFS as a regular user (NOT as root). For this to work, the mount point
must be owned by the user. Therefore, mounting into a `mount` or `mnt` directory you create
inside your home directory is a good practice.
1. If the username is omitted, SSHFS will use the local username.
1. If the directory is omitted, SSHFS will mount the (remote) home directory.
1. If the username (`user@` part of the command) is omitted, SSHFS will use the local username.
1. If the directory is omitted (while keeping the colon `:` just before it), SSHFS will mount the
(remote) home directory.
1. If you need to enter a password, SSHFS will ask for it (actually, it just runs `ssh` which asks
for the password if needed).

Expand All @@ -89,7 +90,7 @@ and BSD (as opposed to MacOS), you will also need to install [libfuse][libfuse]
MacOS, you need [OSXFUSE][OSXFUSE] instead. Finally, you need the [Glib][Glib] library with
development headers, which should be available from your operating system's package manager.

To build and install, we recommend you use [Meson][Meson] (version 0.38 or newer) and
To build and install, you must use [Meson][Meson] (version 0.38 or newer) and
[Ninja][Ninja]. After extracting the `sshfs` tarball, create a (temporary) build directory and run
Meson:

Expand Down Expand Up @@ -177,11 +178,13 @@ change it there too. -->
```
For [sample test output, see here](test/README.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure why it's important to have example output? The tests clearly state if they fail or pass....

Copy link
Author

Choose a reason for hiding this comment

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

It took my a lot of effort and time to get the tests to pass, as you can see from my ssh setup instructions, so I was never able to see what was being tested or what was supposed to happen until I had solved many problems and gotten the tests to run. This removes that mystery.

Copy link
Author

Choose a reason for hiding this comment

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

That being said, there's not a ton of value in it. It's just nice to see what's supposed to happen is all.

1. Install `sshfs`:
1. Normal method:
1. Normal method. This installs `sshfs` at `/usr/local/bin/sshfs`, whereas your normal Linux
distribution's executable is likely in `/usr/bin/sshfs`.
```bash
# To install
sudo ninja install
```
1. "Light" method. This technique simply creates a symlink to the executable in your `~/bin`
1. Alternative method. This technique simply creates a symlink to the executable in your `~/bin`
dir so your Linux distro's install still remain's intact and untouched. (For Ubuntu).
Copy link
Contributor

Choose a reason for hiding this comment

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

This is the case also when using ninja install. Your system's sshfs is in /usr/bin, ninja install into /usr/local/bin.

Copy link
Author

Choose a reason for hiding this comment

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

What's the ninja uninstall command?

Copy link
Contributor

@Nikratio Nikratio Dec 27, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

I don't know. But I also don't see the connection to what I'm saying...? If you install in /usr/locl, then your Linux distro's install remains intact and untouched.

Copy link
Author

Choose a reason for hiding this comment

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

If you install in /usr/locl, then your Linux distro's install remains intact and untouched.

Agreed. So, if someone wants to go back to using their Linux distro's version of sshfs, how do they do that? The logical answer is: run the ninja uninstall command. That's why I asked "what's the ninja uninstall command?" I'd like to write it down here too.

For the "Alternative method" here, I show: rm ~/bin/sshfs.

A few options to uninstall the ninja install might be:

rm /usr/local/bin/sshfs

Or: modify the path to include /urs/local/bin after /usr/bin instead of before it (probably not recommended), or (best, if such a thing exists): sudo ninja uninstall.

Copy link
Contributor

Choose a reason for hiding this comment

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

Have you tried running ninja uninstall? If I understand https://mesonbuild.com/Release-notes-for-0-38-0.html correctly, then this should exist and is probably the best approximation to a true uninstall that we have.

```bash
# "Install" via a symlink. Note: ensure you are in the same dir as the new `sshfs`
Expand Down