Skip to content

Commit 6cb0cc4

Browse files
committed
README.md: update some sections and mention Python3 only compatibility
1 parent d64572c commit 6cb0cc4

File tree

1 file changed

+26
-22
lines changed

1 file changed

+26
-22
lines changed

README.md

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,18 @@
44

55
*oscfs* is a FUSE based user space file system that allows to access open
66
build service (OBS) instances. It is based on the *osc* (openSUSE Commander)
7-
python package for interfacing with OBS. At the moment it provides read-only
7+
Python package for interfacing with OBS. At the moment it provides read-only
88
access for inspecting packages and their metadata.
99

1010
# Dependencies
1111

12-
*oscfs* itself is implemented in python and uses the *fusepy* module to
13-
implement the file system portion. There is another python fuse package called
12+
*oscfs* itself is implemented in Python and uses the *fusepy* module to
13+
implement the file system portion. There is another Python Fuse package called
1414
*python-fuse* which **is not compatible** with *oscfs*.
1515

16-
For accessing OBS instances the python *osc* module is required.
17-
18-
Currently *oscfs* only works with python2, because the *osc* module is not
19-
available for python3 at the moment.
16+
For accessing OBS instances the Python *osc* module is required. The *osc*
17+
module by now is working with Python3, therefore *oscfs* is no longer
18+
supporting Python2 since version 0.8.0.
2019

2120
## Features
2221

@@ -29,37 +28,39 @@ available for python3 at the moment.
2928

3029
## Usage
3130

32-
*oscfs* ships one main script called `oscfs`. It supports a couple of command
31+
*oscfs* ships a main script called `oscfs`. It supports a couple of command
3332
line parameters to influence its behaviour. It should only be called by a
3433
regular user and never by the `root` user.
3534

3635
For mounting the file system simply provide the *mountpoint* argument to the
3736
`oscfs` main script. By default the openSUSE build service is accessed. For
3837
authentication at the OBS instance, the configuration file in the home
39-
directory in `~/.oscrc` needs to be setup. This file is part of the *osc*
40-
python module for which you can find more documentation in the [openSUSE
38+
directory in `~/.config/osc/oscrc` (or `~/.oscrc` on older installations)
39+
needs to be setup. This file is part of the *osc* Python module for which you
40+
can find more documentation in the [openSUSE
4141
wiki](https://en.opensuse.org/openSUSE:OSC).
4242

43-
To specify a different OBS instance, provide the URL via the `--apiurl`
43+
To access a different OBS instance, provide the URL via the `--apiurl`
4444
parameter. For example to mount the SUSE internal build service (IBS) under
45-
the home directory in a directory `ibs` use the following command line:
45+
use a command line like this:
4646

4747
```sh
4848
$ oscfs --apiurl https://api.suse.de ~/ibs
4949
```
5050

51-
By default `oscfs` detaches and runs in the background. For testing purposes
52-
it can be run in the foreground by passing the `-f` parameter.
51+
By default `oscfs` detaches and runs in the background as a daemon. For
52+
testing purposes it can be run in the foreground by passing the `-f`
53+
parameter.
5354

5455
Certain special OBS projects are excluded by default like the users' *home:*
5556
projects, maintenance incident projects or PTF (Program Temporary Fix)
5657
projects. This is the case, because a lot of these projects can exist in an
57-
OBS which would clutter the file system contents.
58+
OBS instance which would clutter the file system contents.
5859

5960
If you want to include these types of projects you can pass the according
60-
command line parameter like `--homes`, `--maintenance` or `--ptf`. Your own
61-
home projects will always be included in the file system independently of the
62-
`--homes` switch.
61+
command line parameter like `--homes`, `--maintenance` or `--ptf`
62+
respectively. Your user account's own home projects will always be included in
63+
the file system independently of the `--homes` switch.
6364

6465
Content that has been fetched from the OBS instance will be cached locally for
6566
a certain time to improve response times. The time before content will be
@@ -68,7 +69,7 @@ refreshed can be tuned via the `--cache-time` parameter.
6869
## File System Structure
6970

7071
On the first level of the file system, a directory for each OBS project is
71-
found. When working against the openSUSE OBS you can find the
72+
found. When accessing the openSUSE OBS instance you can find the
7273
`openSUSE:Factory` directory, for example. On the second level the packages
7374
within a project are found. Within `openSUSE:Factory` all packages that make
7475
up the openSUSE Tumbleweed rolling release codebase are found. For example you
@@ -111,7 +112,7 @@ directory:
111112
- `bugowners`: the same as for projects above.
112113
- `maintainers`: the same as for projects above.
113114
- `description`: contains the human readable description of the package.
114-
- `log`: contains the changelog of the package.
115+
- `log`: contains the commit changelog of the package.
115116
- `meta`: returns the complete XML metadata for the package as provided by the
116117
OBS instance.
117118
- `num_revisions`: returns an integer denoting the number of commit revisions
@@ -171,6 +172,9 @@ lot amount of data from the remote server should be avoided (e.g. don't call
171172
`find` for the complete file system). This would be a kind of denial of
172173
service attack on the remote server.
173174

175+
In a future version of `oscfs` evaluation of remote server modification times
176+
could be used to transparently update cached data when necessary.
177+
174178
### Sorting of Directory Contents
175179

176180
Listing directories with `ls` can feel a bit on the slow side, even if data is
@@ -198,7 +202,7 @@ it was last seen by `oscfs`.
198202
### Finding Packages
199203

200204
You can find packages by using tools like `find` or shell wildcards expansion.
201-
To find all fuse related packages you do this for example:
205+
To find all Fuse related packages you do this for example:
202206

203207
```sh
204208
$ cd openSUSE:Factory
@@ -209,7 +213,7 @@ enblend-enfuse fuse fuse-exfat fuseiso fusepod fusesmb ifuse ldapfuse li
209213
### Matching Lines from RPM Specs
210214

211215
You can query for packages containing certain RPM spec statements. For example
212-
to find packages that require some perl package by using grep like this:
216+
to find packages that require some Perl package by using grep like this:
213217

214218
```sh
215219
$ cd openSUSE:Factory

0 commit comments

Comments
 (0)