rust-raspberrypi-OS-tutorials/.rubocop.yml

# The behavior of RuboCop can be controlled via the .rubocop.yml
# configuration file. It makes it possible to enable/disable
# certain cops (checks) and to alter their behavior if they accept
# any parameters. The file can be placed either in your home
# directory or in some project directory.
#
# RuboCop will start looking for the configuration file in the directory
# where the inspected file is and continue its way up to the root directory.
#
# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md

Layout/IndentationWidth:
    Width: 4
    AllowedPatterns: ['^\s*module']

Layout/LineLength:
    Max: 100

Lint/UnusedMethodArgument:
    AutoCorrect: False

Metrics/AbcSize:
    Max: 25

Metrics/ClassLength:
    Enabled: false

Metrics/MethodLength:
    Max: 20

AllCops:
    NewCops: enable
Adapt tooling settings 2019-10-17 19:49:15 +00:00			`# The behavior of RuboCop can be controlled via the .rubocop.yml`
			`# configuration file. It makes it possible to enable/disable`
			`# certain cops (checks) and to alter their behavior if they accept`
			`# any parameters. The file can be placed either in your home`
			`# directory or in some project directory.`
			`#`
			`# RuboCop will start looking for the configuration file in the directory`
			`# where the inspected file is and continue its way up to the root directory.`
			`#`
			`# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md`

			`Layout/IndentationWidth:`
fix ci/cd error (#195) * fix ci/cd error * update copyright year * Modify remaining years * solve ci report settings.json code style * update .prettierrc.json * prettierrc fix code style * fix rb file i.to_s and code style * fix error Line is too long. [101/100] * Modify the Ruby file format and restore other file formats * update makefile and readme file space 2023-09-15 12:22:15 +00:00			`Width: 4`
			`AllowedPatterns: ['^\s*module']`
Adapt tooling settings 2019-10-17 19:49:15 +00:00
Refactor utils 2020-01-09 21:11:56 +00:00			`Layout/LineLength:`
fix ci/cd error (#195) * fix ci/cd error * update copyright year * Modify remaining years * solve ci report settings.json code style * update .prettierrc.json * prettierrc fix code style * fix rb file i.to_s and code style * fix error Line is too long. [101/100] * Modify the Ruby file format and restore other file formats * update makefile and readme file space 2023-09-15 12:22:15 +00:00			`Max: 100`
Adapt tooling settings 2019-10-17 19:49:15 +00:00
Refactor tests for more synergy 2022-03-14 20:57:58 +00:00			`Lint/UnusedMethodArgument:`
fix ci/cd error (#195) * fix ci/cd error * update copyright year * Modify remaining years * solve ci report settings.json code style * update .prettierrc.json * prettierrc fix code style * fix rb file i.to_s and code style * fix error Line is too long. [101/100] * Modify the Ruby file format and restore other file formats * update makefile and readme file space 2023-09-15 12:22:15 +00:00			`AutoCorrect: False`
Refactor tests for more synergy 2022-03-14 20:57:58 +00:00
Refactor memory subsystem code This patch refactors big chunks of the memory subsystem code. Most of all, it does away with the the design being based around the raw pointer type "*const Page". While raw pointers to an actual page seemed like a compelling idea, in practice it turned out difficult. Rust feels a bit inconsistent with respect to raw pointers. While it is safe to create them out of nowhere (only dereferencing is unsafe), it gets weird when multi-threading comes into picture. For example, wrapping them into synchronization primitives caused issues because they don't implement Send. For this reason, we switch to the PageAddress type which is based on usize, which makes things a lot easier. Other changes/benefits include: - Gets rid of unsafe code in the removed PageSlice type. - Decouple the translation table code and MMIO VA allocation. - For the translation table tool, make better use of what the ELF format already provides with respect to memory segmentation and translation. For example, the tool now queries the ELF file for VA->PA translations and other segment attributes. This has also the added benefit of reduced BSP code and more generic code in the tool. - Packs rbelftools in the Docker image now (used by translation table tool). - In tutorials 14/15/16, rearrange the PA and VA layout. 2021-12-02 19:44:12 +00:00			`Metrics/AbcSize:`
fix ci/cd error (#195) * fix ci/cd error * update copyright year * Modify remaining years * solve ci report settings.json code style * update .prettierrc.json * prettierrc fix code style * fix rb file i.to_s and code style * fix error Line is too long. [101/100] * Modify the Ruby file format and restore other file formats * update makefile and readme file space 2023-09-15 12:22:15 +00:00			`Max: 25`
Refactor memory subsystem code This patch refactors big chunks of the memory subsystem code. Most of all, it does away with the the design being based around the raw pointer type "*const Page". While raw pointers to an actual page seemed like a compelling idea, in practice it turned out difficult. Rust feels a bit inconsistent with respect to raw pointers. While it is safe to create them out of nowhere (only dereferencing is unsafe), it gets weird when multi-threading comes into picture. For example, wrapping them into synchronization primitives caused issues because they don't implement Send. For this reason, we switch to the PageAddress type which is based on usize, which makes things a lot easier. Other changes/benefits include: - Gets rid of unsafe code in the removed PageSlice type. - Decouple the translation table code and MMIO VA allocation. - For the translation table tool, make better use of what the ELF format already provides with respect to memory segmentation and translation. For example, the tool now queries the ELF file for VA->PA translations and other segment attributes. This has also the added benefit of reduced BSP code and more generic code in the tool. - Packs rbelftools in the Docker image now (used by translation table tool). - In tutorials 14/15/16, rearrange the PA and VA layout. 2021-12-02 19:44:12 +00:00
Introducing Minipush, a raspbootcom replacement. Gets rid of compiled C++, uses Ruby 💎 2020-01-14 19:45:41 +00:00			`Metrics/ClassLength:`
fix ci/cd error (#195) * fix ci/cd error * update copyright year * Modify remaining years * solve ci report settings.json code style * update .prettierrc.json * prettierrc fix code style * fix rb file i.to_s and code style * fix error Line is too long. [101/100] * Modify the Ruby file format and restore other file formats * update makefile and readme file space 2023-09-15 12:22:15 +00:00			`Enabled: false`
Introducing Minipush, a raspbootcom replacement. Gets rid of compiled C++, uses Ruby 💎 2020-01-14 19:45:41 +00:00
Adapt tooling settings 2019-10-17 19:49:15 +00:00			`Metrics/MethodLength:`
fix ci/cd error (#195) * fix ci/cd error * update copyright year * Modify remaining years * solve ci report settings.json code style * update .prettierrc.json * prettierrc fix code style * fix rb file i.to_s and code style * fix error Line is too long. [101/100] * Modify the Ruby file format and restore other file formats * update makefile and readme file space 2023-09-15 12:22:15 +00:00			`Max: 20`
rubocop: Enable new cops 2020-07-12 13:09:32 +00:00
			`AllCops:`
fix ci/cd error (#195) * fix ci/cd error * update copyright year * Modify remaining years * solve ci report settings.json code style * update .prettierrc.json * prettierrc fix code style * fix rb file i.to_s and code style * fix error Line is too long. [101/100] * Modify the Ruby file format and restore other file formats * update makefile and readme file space 2023-09-15 12:22:15 +00:00			`NewCops: enable`