Skip to content

Commit

Permalink
doc: improve fs permissions description
Browse files Browse the repository at this point in the history
Fix a small grammatical mistake and improve the surrounding wording.

PR-URL: #47596
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Filip Skokan <panva.ip@gmail.com>
  • Loading branch information
tniessen committed Apr 19, 2023
1 parent 4956271 commit 9a7b971
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
10 changes: 6 additions & 4 deletions doc/api/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,9 @@ the [Permission Model][].

The valid arguments for the `--allow-fs-read` flag are:

* `*` - To allow the `FileSystemRead` operations.
* Paths delimited by comma (,) to manage `FileSystemRead` (reading) operations.
* `*` - To allow all `FileSystemRead` operations.
* Paths delimited by comma (`,`) to allow only matching `FileSystemRead`
operations.

Examples can be found in the [File System Permissions][] documentation.

Expand Down Expand Up @@ -200,8 +201,9 @@ the [Permission Model][].

The valid arguments for the `--allow-fs-write` flag are:

* `*` - To allow the `FileSystemWrite` operations.
* Paths delimited by comma (,) to manage `FileSystemWrite` (writing) operations.
* `*` - To allow all `FileSystemWrite` operations.
* Paths delimited by comma (`,`) to allow only matching `FileSystemWrite`
operations.

Examples can be found in the [File System Permissions][] documentation.

Expand Down
6 changes: 4 additions & 2 deletions doc/api/permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -520,8 +520,10 @@ Hello world!

The valid arguments for both flags are:

* `*` - To allow the all operations to given scope (read/write).
* Paths delimited by comma (,) to manage reading/writing operations.
* `*` - To allow all `FileSystemRead` or `FileSystemWrite` operations,
respectively.
* Paths delimited by comma (`,`) to allow only matching `FileSystemRead` or
`FileSystemWrite` operations, respectively.

Example:

Expand Down

0 comments on commit 9a7b971

Please sign in to comment.