Skip to content

Commit

Permalink
tools: Update tidy.sh and related configs/markers
Browse files Browse the repository at this point in the history
  • Loading branch information
taiki-e committed Feb 2, 2025
1 parent 96e1aba commit df81abc
Show file tree
Hide file tree
Showing 6 changed files with 434 additions and 209 deletions.
15 changes: 8 additions & 7 deletions .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,24 +27,25 @@
"ignoreRegExpList": [
// Copyright notice
"Copyright .*",
"SPDX-(File|Snippet)CopyrightText: .*",
// GHA actions/workflows
"uses: .+@",
"uses: .+@[\\w_.-]+",
// GHA context (repo name, owner name, etc.)
"github.\\w+ (=|!)= '.+'",
"github.[\\w_.-]+ (=|!)= '[^']+'",
// GH username
"( |\\[)@[\\w_-]+",
// Git config username
"git config user.name .*",
// Username in todo comment
"git config( --[^ ]+)? user.name .*",
// Username in TODO|FIXME comment
"(TODO|FIXME)\\([\\w_., -]+\\)",
// Cargo.toml authors
"authors *= *\\[.*\\]",
"\".* <[\\w_.+-]+@[\\w.-]+>\""
"authors *= *\\[[^\\]]*\\]",
"\"[^\"]* <[\\w_.+-]+@[\\w.-]+>\""
],
"languageSettings": [
{
"languageId": ["*"],
"dictionaries": ["bash", "rust"]
"dictionaries": ["bash", "cpp-refined", "rust"]
}
],
"ignorePaths": [
Expand Down
4 changes: 3 additions & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,14 @@ indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

[*.{json,md,rb,sh,yml,yaml}]
[*.{css,html,json,md,rb,sh,yml,yaml}]
indent_size = 2

[*.{js,yml,yaml}]
quote_type = single

[*.sh]
# https://google.github.io/styleguide/shellguide.html#s5.3-pipelines
binary_next_line = true
# https://google.github.io/styleguide/shellguide.html#s5.5-case-statement
switch_case_indent = true
7 changes: 0 additions & 7 deletions .github/.cspell/project-dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,9 @@ CMDLINE
CREAT
demangle
ebreak
EINTR
EINVAL
errno
espup
fipe
FLEN
fopen
fstat
heapinfo
IFCHR
Expand Down Expand Up @@ -64,9 +60,6 @@ syscall
TDMI
Tensilica
tickfreq
timespec
TMPNAM
TRUNC
ucrt
Uncategorized
unseekable
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
[![msrv](https://img.shields.io/badge/msrv-1.64-blue?style=flat-square&logo=rust)](https://www.rust-lang.org)
[![github actions](https://img.shields.io/github/actions/workflow/status/taiki-e/semihosting/ci.yml?branch=main&style=flat-square&logo=github)](https://github.com/taiki-e/semihosting/actions)

<!-- tidy:crate-doc:start -->
<!-- tidy:sync-markdown-to-rustdoc:start:src/lib.rs -->

Semihosting for AArch64, Arm, RISC-V, MIPS32, MIPS64, and Xtensa.

This library provides access to semihosting, a mechanism for programs running on the real or virtual (e.g., QEMU) target to communicate with I/O facilities on the host system. See the [Arm documentation](https://github.com/ARM-software/abi-aa/blob/2024Q3/semihosting/semihosting.rst) for more information on semihosting.
Expand Down Expand Up @@ -213,7 +214,7 @@ semihosting = { version = "0.1", features = ["stdio", "panic-handler"] }
[rustfilt]: https://github.com/luser/rustfilt
[unwinding]: https://github.com/nbdd0121/unwinding
<!-- tidy:crate-doc:end -->
<!-- tidy:sync-markdown-to-rustdoc:end -->
## License
Expand Down
7 changes: 5 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
// SPDX-License-Identifier: Apache-2.0 OR MIT

/*!
<!-- tidy:crate-doc:start -->
<!-- Note: Document from sync-markdown-to-rustdoc:start through sync-markdown-to-rustdoc:end
is synchronized from README.md. Any changes to that range are not preserved. -->
<!-- tidy:sync-markdown-to-rustdoc:start -->
Semihosting for AArch64, Arm, RISC-V, MIPS32, MIPS64, and Xtensa.
This library provides access to semihosting, a mechanism for programs running on the real or virtual (e.g., QEMU) target to communicate with I/O facilities on the host system. See the [Arm documentation](https://github.com/ARM-software/abi-aa/blob/2024Q3/semihosting/semihosting.rst) for more information on semihosting.
Expand Down Expand Up @@ -208,7 +211,7 @@ semihosting = { version = "0.1", features = ["stdio", "panic-handler"] }
[rustfilt]: https://github.com/luser/rustfilt
[unwinding]: https://github.com/nbdd0121/unwinding
<!-- tidy:crate-doc:end -->
<!-- tidy:sync-markdown-to-rustdoc:end -->
*/

#![no_std]
Expand Down
Loading

0 comments on commit df81abc

Please # to comment.