From 59ea93e9cd73f49912fb7baf2fcf50af1388556d Mon Sep 17 00:00:00 2001 From: hexkyz Date: Sun, 26 Apr 2020 19:18:49 +0100 Subject: [PATCH] docs: style fixes --- docs/components/modules/ams_mitm.md | 6 +++--- docs/components/modules/boot.md | 2 +- docs/components/modules/boot2.md | 2 +- docs/components/modules/creport.md | 2 +- docs/components/modules/dmnt.md | 2 +- docs/components/modules/eclct.stub.md | 2 +- docs/components/modules/erpt.md | 2 +- docs/components/modules/fatal.md | 2 +- docs/components/modules/jpegdec.md | 2 +- docs/components/modules/loader.md | 2 +- docs/components/modules/ncm.md | 2 +- docs/components/modules/pgl.md | 2 +- docs/components/modules/pm.md | 2 +- docs/components/modules/ro.md | 2 +- docs/components/modules/sm.md | 2 +- docs/components/modules/spl.md | 2 +- docs/features/cheats.md | 20 +++++--------------- 17 files changed, 23 insertions(+), 33 deletions(-) diff --git a/docs/components/modules/ams_mitm.md b/docs/components/modules/ams_mitm.md index a186de336..90f143067 100644 --- a/docs/components/modules/ams_mitm.md +++ b/docs/components/modules/ams_mitm.md @@ -3,8 +3,8 @@ This module provides methods to intercept services provided by other system modu ## bpc_mitm bpc_mitm enables intercepting requests to power control services. It currently intercepts: -+ "am" system module (to intercept the Reboot/Power buttons in the overlay menu) -+ "fatal" system module (to simplify payload reboot logic significantly) ++ `am` system module (to intercept the Reboot/Power buttons in the overlay menu) ++ `fatal` system module (to simplify payload reboot logic significantly) + Homebrew Loader (to allow homebrew to take advantage of the feature) ## fs_mitm @@ -20,7 +20,7 @@ ns_mitm enables intercepting requests to application control services. It curren ## set_mitm set_mitm enables intercepting requests to the system settings service. It currently intercepts: -+ "ns" system module and games (to allow for overriding game locales) ++ `ns` system module and games (to allow for overriding game locales) + All settings requests ### Firmware Version diff --git a/docs/components/modules/boot.md b/docs/components/modules/boot.md index 6612184e1..c0005584b 100644 --- a/docs/components/modules/boot.md +++ b/docs/components/modules/boot.md @@ -1,4 +1,4 @@ # boot -This module is a reimplementation of the Horizon OS's "boot" system module, which is responsible for initializing and configuring hardware. +This module is a reimplementation of the Horizon OS's `boot` system module, which is responsible for initializing and configuring hardware. Atmosphère's reimplementation displays its own black and white splash screen and battery icons as replacements for the original assets used during display initialization. diff --git a/docs/components/modules/boot2.md b/docs/components/modules/boot2.md index c07b861ab..4b7e6f995 100644 --- a/docs/components/modules/boot2.md +++ b/docs/components/modules/boot2.md @@ -1,4 +1,4 @@ # boot2 -This module is a reimplementation of the Horizon OS's "boot2" system module, which is responsible for launching all the other necessary system modules. +This module is a reimplementation of the Horizon OS's `boot2` system module, which is responsible for launching all the other necessary system modules. Atmosphère's reimplementation allows launching user provided system modules from the SD card. See [here](../../features/configurations.md) for more information. diff --git a/docs/components/modules/creport.md b/docs/components/modules/creport.md index 8e61c465f..0517840de 100644 --- a/docs/components/modules/creport.md +++ b/docs/components/modules/creport.md @@ -1,4 +1,4 @@ # creport -This module is a reimplementation of the Horizon OS's "creport" system module, which is responsible for managing crash reports. +This module is a reimplementation of the Horizon OS's `creport` system module, which is responsible for managing crash reports. Atmosphère's reimplementation redirects writing of generated crash reports to the SD card under the folder `/atmosphere/crash_reports/`. It also prevents the automatic uploading of said crash reports. diff --git a/docs/components/modules/dmnt.md b/docs/components/modules/dmnt.md index c65c295c3..aa9f5fa71 100644 --- a/docs/components/modules/dmnt.md +++ b/docs/components/modules/dmnt.md @@ -1,5 +1,5 @@ # dmnt -This module is a reimplementation of the Horizon OS's "dmnt" system module, which provides a debug monitor. +This module is a reimplementation of the Horizon OS's `dmnt` system module, which provides a debug monitor. ## Extensions Atmosphère implements an extension to provide cheat code functionality. diff --git a/docs/components/modules/eclct.stub.md b/docs/components/modules/eclct.stub.md index 0993ff026..c33df9e36 100644 --- a/docs/components/modules/eclct.stub.md +++ b/docs/components/modules/eclct.stub.md @@ -1,4 +1,4 @@ # eclct.stub -This module is a reimplementation of the Horizon OS's "eclct" system module, which collects error reports. +This module is a reimplementation of the Horizon OS's `eclct` system module, which collects error reports. Atmosphère's reimplementation is a stub to remove any and all functionality pertaining to error report collection. diff --git a/docs/components/modules/erpt.md b/docs/components/modules/erpt.md index ffaeb648d..dd8e459f6 100644 --- a/docs/components/modules/erpt.md +++ b/docs/components/modules/erpt.md @@ -1,4 +1,4 @@ # erpt -This module is a reimplementation of the Horizon OS's "erpt" system module, which is responsible for managing error reports. +This module is a reimplementation of the Horizon OS's `erpt` system module, which is responsible for managing error reports. Atmosphère's reimplementation redirects writing of generated error reports to the SD card under the folder `/atmosphere/erpt_reports/`. diff --git a/docs/components/modules/fatal.md b/docs/components/modules/fatal.md index 556cd0e42..3a17c94d0 100644 --- a/docs/components/modules/fatal.md +++ b/docs/components/modules/fatal.md @@ -1,4 +1,4 @@ # fatal -This module is a reimplementation of the Horizon OS's "fatal" system module, which is responsible for managing fatal reports. +This module is a reimplementation of the Horizon OS's `fatal` system module, which is responsible for managing fatal reports. Atmosphère's reimplementation prevents error report creation and draws a custom error screen, showing registers and a backtrace. It also attempts to gather debugging info for any and all crashes and tries to save reports to the SD card under the folder `/atmosphere/fatal_reports/` (if a crash report was not generated). diff --git a/docs/components/modules/jpegdec.md b/docs/components/modules/jpegdec.md index d04403472..fcc0d3abe 100644 --- a/docs/components/modules/jpegdec.md +++ b/docs/components/modules/jpegdec.md @@ -1,4 +1,4 @@ # jpegdec -This module is a reimplementation of the Horizon OS's "jpegdec" system module, which is responsible for JPEG format decoding. +This module is a reimplementation of the Horizon OS's `jpegdec` system module, which is responsible for JPEG format decoding. Atmosphère's reimplementation allows two sessions instead of 1, so homebrew can use it for software JPEG decoding in addition to the OS itself. diff --git a/docs/components/modules/loader.md b/docs/components/modules/loader.md index 174e9978b..b4e363cae 100644 --- a/docs/components/modules/loader.md +++ b/docs/components/modules/loader.md @@ -1,5 +1,5 @@ # loader -This module is a reimplementation of the Horizon OS's "ldr" system module, which is responsible for creating processes from executable NSO images and registering their access control. +This module is a reimplementation of the Horizon OS's `ldr` system module, which is responsible for creating processes from executable NSO images and registering their access control. ## Extensions Atmosphère extends this module to allow executables to be replaced or patched by files stored on the SD card. Note that a few services are required for SD card access and therefore cannot be replaced or patched in this manner. diff --git a/docs/components/modules/ncm.md b/docs/components/modules/ncm.md index f9ef25019..5a4971d91 100644 --- a/docs/components/modules/ncm.md +++ b/docs/components/modules/ncm.md @@ -1,4 +1,4 @@ # ncm -This module is a reimplementation of the Horizon OS's "ncm" system module, which is responsible content management. +This module is a reimplementation of the Horizon OS's `ncm` system module, which is responsible content management. Atmosphère's reimplementation is currently opt-in only. See [here](../../features/configurations.md) for more information. diff --git a/docs/components/modules/pgl.md b/docs/components/modules/pgl.md index bc8eaed77..fa1658a8d 100644 --- a/docs/components/modules/pgl.md +++ b/docs/components/modules/pgl.md @@ -1,2 +1,2 @@ # pgl -This module is a reimplementation of the Horizon OS's "pgl" system module, which is responsible for launching programs. +This module is a reimplementation of the Horizon OS's `pgl` system module, which is responsible for launching programs. diff --git a/docs/components/modules/pm.md b/docs/components/modules/pm.md index 9681adde5..cc52a460d 100644 --- a/docs/components/modules/pm.md +++ b/docs/components/modules/pm.md @@ -1,5 +1,5 @@ # pm -This module is a reimplementation of the Horizon OS's "pm" system module, which is responsible for tracking running processes on the system, and managing resource limits. +This module is a reimplementation of the Horizon OS's `pm` system module, which is responsible for tracking running processes on the system, and managing resource limits. ## Extensions Atmosphère extends this module with extra IPC commands and memory restriction changes. diff --git a/docs/components/modules/ro.md b/docs/components/modules/ro.md index b0389dc39..9f6f7d767 100644 --- a/docs/components/modules/ro.md +++ b/docs/components/modules/ro.md @@ -1,5 +1,5 @@ # ro -This module is a reimplementation of the Horizon OS's "ro" system module, which is responsible for loading dynamic libraries. +This module is a reimplementation of the Horizon OS's `ro` system module, which is responsible for loading dynamic libraries. ## Extensions Atmosphère extends this module to allow libraries to be patched by files stored on the SD card. diff --git a/docs/components/modules/sm.md b/docs/components/modules/sm.md index 1c709c9ea..bba1712d8 100644 --- a/docs/components/modules/sm.md +++ b/docs/components/modules/sm.md @@ -1,5 +1,5 @@ # sm -This module is a reimplementation of the Horizon OS's "sm" system module, which is responsible for service management. +This module is a reimplementation of the Horizon OS's `sm` system module, which is responsible for service management. ## Extensions Atmosphère extends this module with extra IPC commands and new services. diff --git a/docs/components/modules/spl.md b/docs/components/modules/spl.md index 72d5c3a5e..ec1605a40 100644 --- a/docs/components/modules/spl.md +++ b/docs/components/modules/spl.md @@ -1,2 +1,2 @@ # spl -This module is a reimplementation of the Horizon OS's "spl" system module, which is responsible for providing secure platform services such as cryptographic operations. +This module is a reimplementation of the Horizon OS's `spl` system module, which is responsible for providing secure platform services such as cryptographic operations. diff --git a/docs/features/cheats.md b/docs/features/cheats.md index 68f0ab0b0..007a50584 100644 --- a/docs/features/cheats.md +++ b/docs/features/cheats.md @@ -333,9 +333,7 @@ C0TcS5X0 Code type 0xC1 performs saving or restoring of registers. #### Encoding -``` -C10D0Sx0 -``` +`C10D0Sx0` + D: Destination index. + S: Source index. @@ -353,9 +351,7 @@ C10D0Sx0 Code type 0xC2 performs saving or restoring of multiple registers using a bitmask. #### Encoding -``` -C2x0XXXX -``` +`C2x0XXXX` + x: Operand Type, see below. + X: 16-bit bitmask, bit i == save or restore register i. @@ -372,9 +368,7 @@ C2x0XXXX Code type 0xC3 reads or writes a static register with a given register. #### Encoding -``` -C3000XXx -``` +`C3000XXx` + XX: Static register index, 0x00 to 0x7F for reading or 0x80 to 0xFF for writing. + x: Register index. @@ -392,9 +386,7 @@ This reserves an additional 16 opcodes for future use. Code type 0xFF0 pauses the current process. #### Encoding -``` -FF0????? -``` +`FF0?????` --- @@ -402,9 +394,7 @@ FF0????? Code type 0xFF1 resumes the current process. #### Encoding -``` -FF1????? -``` +`FF1?????` ---