Skip to content

Commit af9e0a4

Browse files
committed
Review changes.
1 parent 0b10b3d commit af9e0a4

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

docs/src/further_topics/s3_io.rst

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ which should explain what you need here.
108108
Before use (before each Python invocation)
109109
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
110110
Activate your Python environment, which then gives access to the **s3-fuse** Linux
111-
command -- which, somewhat confusingly, is called ``s3fs``.
111+
command "s3fs".
112112

113113
Map your S3 bucket "into" the chosen empty directory -- e.g.
114114

@@ -130,11 +130,16 @@ Map your S3 bucket "into" the chosen empty directory -- e.g.
130130
If you reboot, the mount will disappear. If you logout and login again, there can
131131
be problems : ideally you should avoid this by always "unmounting" (see below).
132132

133+
.. note::
134+
135+
The command for mounting an s3-fuse filesystem is ``s3fs`` - this should not be
136+
confused with the similarly named s3fs python package.
137+
133138

134139
Within Python code
135140
^^^^^^^^^^^^^^^^^^
136-
Access files stored as S3 objects "under" the S3 url, appearing as files under the
137-
You can now access objects at the remote S3 URL via the mount point on your local file system you just created with `s3fs`, e.g.
141+
You can now access objects at the remote S3 URL via the mount point on your local file
142+
system you just created with `s3fs`, e.g.
138143

139144
.. code-block:: python
140145
@@ -197,6 +202,11 @@ CONs
197202

198203
* only works on Unix-like O.S.
199204

205+
* requires the "fuse" kernel module to be supported in your O.S.
206+
This is usually installed by default, but may not always be.
207+
See `'fuse' kernel module <https://www.kernel.org/doc/html/next/filesystems/fuse.html>`_
208+
for more detail.
209+
200210
* the file-system virtualisation may not be perfect : some file-system operations
201211
might not behave as expected, e.g. with regard to file permissions or system
202212
information.

0 commit comments

Comments
 (0)