Skip to content

Commit

Permalink
Fix: broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
ClementNerma committed Oct 6, 2023
1 parent 80b1c81 commit c3285ed
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 29 deletions.
1 change: 0 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ The list of default applications and their description can be found [here](appli
- [Developer mode](technical/dev-mode.md) - enable powerful development options
- [Devices](technical/devices.md) - manage hardware devices
- [File formats](technical/file-formats.md) - description of all native file formats
- [Integrity checker](technical/integrity-checker.md) - ensure the system hasn't been corrupted
- [I/O manager](technical/io-manager.md) - manage input/output requests
- [Multi-platform management](technical/multi-platform.md) - how the NightOS ecosystem can be used on other operating systems
- [Performances](technical/performances.md) - system tweaks used to optimize general and specific-case performances
Expand Down
2 changes: 1 addition & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
- [Developer mode](technical/dev-mode.md) - enable powerful development options
- [Devices](technical/devices.md) - manage hardware devices
- [File formats](technical/file-formats.md) - description of all native file formats
- [Integrity checker](technical/integrity-checker.md) - ensure the system hasn't been corrupted
- [I/O manager](technical/io-manager.md) - manage input/output requests
- [Multi-platform management](technical/multi-platform.md) - how the NightOS ecosystem can be used on other operating systems
- [Performances](technical/performances.md) - system tweaks used to optimize general and specific-case performances
Expand All @@ -42,6 +41,7 @@
- [Applications and libraries](specs/applications-libraries.md) - what applications and libraries are
- [Applications](specs/applications.md) - how applications are structured and behave
- [Filesystem](specs/filesystem.md) - how the filesystem works
- [Boot process](specs/boot-process.md) - how the system starts
- [Storage permissions](specs/storage-permissions.md) - how permissions are managed on filesystem elements
- [Libraries](specs/libraries.md) - what are libraries
- [Permissions](specs/permissions.md) - list of applications' permissions
Expand Down
2 changes: 1 addition & 1 deletion docs/features/crash-saves.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ If the application didn't answer when the next collect occurs, the signal is abo

When a crash save has been collected for a given application, it is stored in `/home/[user]/appdata/[appname]/crashsaves/[timestamp]_[pid].csf`.

_NOTE:_ Crash saves' intregrity is controlled using the system's [integrity checker](../technical/integrity-checker.md).
_NOTE:_ Crash saves' intregrity is controlled during the boot process.

All [native applications](../applications/README.md) support crash saves.
1 change: 1 addition & 0 deletions docs/specs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ For more informations about low-level concepts these documents refer to, you can

- [Applications and libraries](applications-libraries.md) - document describing common things between applications and libraries
- [Applications](applications.md) - how applications are structured and behave
- [Boot process](boot-process.md) - how the system starts
- [Filesystem](filesystem.md) - how the filesystem works
- [Storage permissions](storage-permissions.md) - how permissions are managed on filesystem elements
- [Libraries](libraries.md) - what are libraries
Expand Down
4 changes: 2 additions & 2 deletions docs/specs/filesystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,8 +191,8 @@ _NOTE:_ `<F>` indicates the item is a file.
Links:

- (1) [UPE requests](../concepts/users.md#user-privileges-elevation-upe)
- (2) The [integrity checker](../technical/integrity-checker.md)
- (3) Global storage's [encryption key](../features/encryption.md#global-encryption)
- (2) Used for [integrity checking](../specs/boot-process.md)
- (3) Global storage's [encryption](../features/encryption.md) key

### Notes

Expand Down
26 changes: 3 additions & 23 deletions docs/specs/services/system/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@ The `sys::fs` service is in charge of operations related to the [filesystems](..
- [`0x5001` UPDATE\_SYMLINK](#0x5001-update_symlink)
- [`0x5002` READ\_SYMLINK](#0x5002-read_symlink)
- [`0xA000` WATCH\_ITEM](#0xa000-watch_item)
- [`0xA001` WATCH\_DIR\_CONTENT](#0xa001-watch_dir_content)
- [`0xA002` UNWATCH](#0xa002-unwatch)
- [`0xA001` UNWATCH](#0xa001-unwatch)
- [`0xF000` FORMAT](#0xf000-format)
- [Notifications](#notifications)
- [`0x0006` FS\_CHANGED](#0x0006-fs_changed)
Expand Down Expand Up @@ -640,28 +639,9 @@ Watch an item for changes on its metadata or content. Any change will trigger a
- `0x3000`: Invalid FSID provided
- `0x3001`: Provided path was not found

### `0xA001` WATCH_DIR_CONTENT
### `0xA001` UNWATCH

Watch a directory's content for changes on its metadata or content. Any change will trigger a [`DIR_CONTENT_CHANGED`](#0xa001-dir_content_changed) notification.

**Required permission:**

- `fs.dir.read`

**Arguments:**

- [FSID](../../filesystem.md#filesystem-unique-identifier) (8 bytes)
- [Path](../integration/filesystem-interfaces.md#filesystem-paths) to watch
- Generated watch identifier (8 bytes)

**Errors:**

- `0x3000`: Invalid FSID provided
- `0x3001`: Provided path was not found

### `0xA002` UNWATCH

Stop watching a content watched with [`WATCH_ITEM`](#0xa000-watch_item) or [`WATCH_DIR_CONTENT`](#0xa001-watch_dir_content).
Stop watching a content watched with [`WATCH_ITEM`](#0xa000-watch_item).

**Arguments:**

Expand Down
1 change: 0 additions & 1 deletion docs/technical/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ A global overview of the system can be found in the [overview document](overview
- [The controller](controller.md) - permissions management system
- [Developer mode](dev-mode.md) - enable powerful development options
- [File formats](file-formats.md) - description of all native file formats
- [Integrity checker](integrity-checker.md) - ensure the system hasn't been corrupted
- [I/O manager](io-manager.md) - manage input/output requests
- [Inter-process communication](ipc.md) - communication between processes
- [Multi-platform management](multi-platform.md) - how the NightOS ecosystem can be used on other operating systems
Expand Down

0 comments on commit c3285ed

Please sign in to comment.