From b90cf8f5fc5d954a9d5ba44a46378d91a5fb4ca8 Mon Sep 17 00:00:00 2001 From: wmat Date: Tue, 11 Mar 2025 07:54:04 -0400 Subject: [PATCH 01/33] Generating a PR to test Vale. --- src/a_few_basics.adoc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/a_few_basics.adoc b/src/a_few_basics.adoc index 2742a71..0c0b509 100644 --- a/src/a_few_basics.adoc +++ b/src/a_few_basics.adoc @@ -3,6 +3,9 @@ pseudoinstruction pseudo-instruction +CsR +cSR +CSR AsciiDoc is fully documented, and its documentation is actively maintained. This document contains some information on AsciiDoc markup to get you started. From dd26a1df345f47cdc8fcf791d26c668f6d460462 Mon Sep 17 00:00:00 2001 From: wmat Date: Tue, 11 Mar 2025 08:58:44 -0400 Subject: [PATCH 02/33] Fixing up .vale.ini --- .vale.ini | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.vale.ini b/.vale.ini index 5560813..795e5e9 100644 --- a/.vale.ini +++ b/.vale.ini @@ -8,16 +8,16 @@ StylesPath = styles #Packages = RedHat Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip -#Vocab = riscv-vocab +Vocab = riscv-vocab -#[*.adoc] -#BasedOnStyles = Vale, RISCV-Vale, AsciiDoc +[*.adoc] +BasedOnStyles = Vale, RISCV-Vale, AsciiDoc #[*.md] #BasedOnStyles = Vale, RISCV-Vale, AsciiDoc -# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. -#TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[) + Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. +TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[) # Match INI files. See: https://docs.errata.ai/vale/scoping #[*.ini] From f1f5df135c437df955369f4b2f0d40b530ded8e1 Mon Sep 17 00:00:00 2001 From: wmat Date: Tue, 11 Mar 2025 09:00:12 -0400 Subject: [PATCH 03/33] Fix typo --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 795e5e9..3306afc 100644 --- a/.vale.ini +++ b/.vale.ini @@ -16,7 +16,7 @@ BasedOnStyles = Vale, RISCV-Vale, AsciiDoc #[*.md] #BasedOnStyles = Vale, RISCV-Vale, AsciiDoc - Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. +#Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[) # Match INI files. See: https://docs.errata.ai/vale/scoping From 0d3995f8b255c4411387c83ba9ccfbd069a1fd52 Mon Sep 17 00:00:00 2001 From: wmat Date: Tue, 11 Mar 2025 09:01:43 -0400 Subject: [PATCH 04/33] Set styles name correctly --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 3306afc..4b159e1 100644 --- a/.vale.ini +++ b/.vale.ini @@ -11,7 +11,7 @@ Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/co Vocab = riscv-vocab [*.adoc] -BasedOnStyles = Vale, RISCV-Vale, AsciiDoc +BasedOnStyles = Vale, riscv, AsciiDoc #[*.md] #BasedOnStyles = Vale, RISCV-Vale, AsciiDoc From fea5c9d9430622501829e15b1cfd6e8e65a41a43 Mon Sep 17 00:00:00 2001 From: wmat Date: Tue, 11 Mar 2025 10:22:29 -0400 Subject: [PATCH 05/33] Ignore the styles dir --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 268ce25..8154ebb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +/styles/* /build/* /images/stem* git_sha.adoc From 030153541b9898cc888f54801dec03c4b1ebb655 Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 10:58:32 -0400 Subject: [PATCH 06/33] Adding AsciiDoc package. --- .vale.ini | 1 + 1 file changed, 1 insertion(+) diff --git a/.vale.ini b/.vale.ini index 4b159e1..a289681 100644 --- a/.vale.ini +++ b/.vale.ini @@ -6,6 +6,7 @@ StylesPath = styles #SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock #Packages = RedHat +Packages = AsciiDoc Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip Vocab = riscv-vocab From 0dbcc15ded5c14f9538aec8d0aefd5ba02948ab1 Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 11:02:38 -0400 Subject: [PATCH 07/33] Setting styles path Styles path isn't picking up correctly --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index a289681..775dcbf 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,4 +1,4 @@ -StylesPath = styles +StylesPath = /styles #MinAlertLevel = suggestion #IgnoredScopes = code, tt, img, url, a, body.id From c8c9ce1617f469bf12ee0a94f04b3fe4a792e07f Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 11:04:59 -0400 Subject: [PATCH 08/33] Setting styles path back. --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 775dcbf..a289681 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,4 +1,4 @@ -StylesPath = /styles +StylesPath = styles #MinAlertLevel = suggestion #IgnoredScopes = code, tt, img, url, a, body.id From ebc1083dfa382da7f15ccab9f4327a16a589a883 Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 11:14:57 -0400 Subject: [PATCH 09/33] Remove styles from gitignore --- .gitignore | 1 - 1 file changed, 1 deletion(-) diff --git a/.gitignore b/.gitignore index 8154ebb..268ce25 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,3 @@ -/styles/* /build/* /images/stem* git_sha.adoc From d57f65321e5377162d527974ed51ce86bfb4cd73 Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 11:20:01 -0400 Subject: [PATCH 10/33] Mv styles dir into recommended .github dir --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index a289681..5e153d0 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,4 +1,4 @@ -StylesPath = styles +StylesPath = .github/styles #MinAlertLevel = suggestion #IgnoredScopes = code, tt, img, url, a, body.id From c43d613f6c4a7fdf3eb6f2a2a73eda8efbed325a Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 11:25:12 -0400 Subject: [PATCH 11/33] Test without the riscv package --- .vale.ini | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.vale.ini b/.vale.ini index 5e153d0..24dcc1a 100644 --- a/.vale.ini +++ b/.vale.ini @@ -7,9 +7,9 @@ StylesPath = .github/styles #Packages = RedHat Packages = AsciiDoc -Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip -Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip -Vocab = riscv-vocab +#Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip +#Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip +#Vocab = riscv-vocab [*.adoc] BasedOnStyles = Vale, riscv, AsciiDoc From a25de590af92be054e45ccfe5f9e496e53d870a7 Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 11:26:55 -0400 Subject: [PATCH 12/33] Test 2 without riscv package --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 24dcc1a..4ae70d6 100644 --- a/.vale.ini +++ b/.vale.ini @@ -12,7 +12,7 @@ Packages = AsciiDoc #Vocab = riscv-vocab [*.adoc] -BasedOnStyles = Vale, riscv, AsciiDoc +BasedOnStyles = Vale, AsciiDoc #[*.md] #BasedOnStyles = Vale, RISCV-Vale, AsciiDoc From 56b659861c86b7dda1cc606e5c2b8c49be1079ea Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 11:41:15 -0400 Subject: [PATCH 13/33] Add riscv package back --- .vale.ini | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.vale.ini b/.vale.ini index 4ae70d6..6999548 100644 --- a/.vale.ini +++ b/.vale.ini @@ -7,9 +7,9 @@ StylesPath = .github/styles #Packages = RedHat Packages = AsciiDoc -#Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip -#Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip -#Vocab = riscv-vocab +Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip +Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip +Vocab = riscv-vocab [*.adoc] BasedOnStyles = Vale, AsciiDoc From 4de28141dcf28acf4d75643e30c92e0f1d04f91f Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 11:44:03 -0400 Subject: [PATCH 14/33] Test --- .vale.ini | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.vale.ini b/.vale.ini index 6999548..4ae70d6 100644 --- a/.vale.ini +++ b/.vale.ini @@ -7,9 +7,9 @@ StylesPath = .github/styles #Packages = RedHat Packages = AsciiDoc -Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip -Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip -Vocab = riscv-vocab +#Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip +#Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip +#Vocab = riscv-vocab [*.adoc] BasedOnStyles = Vale, AsciiDoc From 588af2f5fcfa77cacdc50089f3b1be725e84ab06 Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 11:49:21 -0400 Subject: [PATCH 15/33] Removing Vale style ref --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 4ae70d6..b6c6b6b 100644 --- a/.vale.ini +++ b/.vale.ini @@ -12,7 +12,7 @@ Packages = AsciiDoc #Vocab = riscv-vocab [*.adoc] -BasedOnStyles = Vale, AsciiDoc +BasedOnStyles = AsciiDoc #[*.md] #BasedOnStyles = Vale, RISCV-Vale, AsciiDoc From d383302acb5c0d56b02f98fa72e4236d05e0dc2d Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 11:54:20 -0400 Subject: [PATCH 16/33] Trying again with riscv package --- .vale.ini | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.vale.ini b/.vale.ini index b6c6b6b..c53a66e 100644 --- a/.vale.ini +++ b/.vale.ini @@ -7,12 +7,12 @@ StylesPath = .github/styles #Packages = RedHat Packages = AsciiDoc -#Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip -#Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip -#Vocab = riscv-vocab +Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip +Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip +Vocab = riscv-vocab [*.adoc] -BasedOnStyles = AsciiDoc +BasedOnStyles = AsciiDoc, riscv #[*.md] #BasedOnStyles = Vale, RISCV-Vale, AsciiDoc From 75c82020967fe198e5d7735101af6c01f66fa688 Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 12:36:03 -0400 Subject: [PATCH 17/33] Move to a single packages line --- .vale.ini | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.vale.ini b/.vale.ini index c53a66e..6cd4f2f 100644 --- a/.vale.ini +++ b/.vale.ini @@ -6,9 +6,7 @@ StylesPath = .github/styles #SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock #Packages = RedHat -Packages = AsciiDoc -Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip -Packages = https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip +Packages = AsciiDoc,https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip, https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip Vocab = riscv-vocab [*.adoc] From 637b7c4859e8d76e2769aa9578236181465b66b9 Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 12:47:13 -0400 Subject: [PATCH 18/33] Test without riscv style again --- .vale.ini | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.vale.ini b/.vale.ini index 6cd4f2f..90e7491 100644 --- a/.vale.ini +++ b/.vale.ini @@ -10,7 +10,7 @@ Packages = AsciiDoc,https://github.com/riscv-admin/riscv-vale/releases/latest/do Vocab = riscv-vocab [*.adoc] -BasedOnStyles = AsciiDoc, riscv +BasedOnStyles = AsciiDoc #[*.md] #BasedOnStyles = Vale, RISCV-Vale, AsciiDoc @@ -20,7 +20,7 @@ TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\ # Match INI files. See: https://docs.errata.ai/vale/scoping #[*.ini] -#BasedOnStyles = Vale, RISCV-Vale +#BasedOnStyles = Vale # Disabling rules (NO) #RedHat.CaseSensitiveTerms = NO From 67f21d3461f265d9016a51080c7a9c7ccb68ea7a Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 12:49:40 -0400 Subject: [PATCH 19/33] Remove any BasedOnStles values, rely on remote ini file --- .vale.ini | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.vale.ini b/.vale.ini index 90e7491..71ff327 100644 --- a/.vale.ini +++ b/.vale.ini @@ -9,8 +9,8 @@ StylesPath = .github/styles Packages = AsciiDoc,https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip, https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip Vocab = riscv-vocab -[*.adoc] -BasedOnStyles = AsciiDoc +#[*.adoc] +#BasedOnStyles = AsciiDoc #[*.md] #BasedOnStyles = Vale, RISCV-Vale, AsciiDoc From 81abdfdee4c3143056608aacf14458aeacab48c2 Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 12:54:04 -0400 Subject: [PATCH 20/33] remove tokenignores line --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 71ff327..50db9df 100644 --- a/.vale.ini +++ b/.vale.ini @@ -16,7 +16,7 @@ Vocab = riscv-vocab #BasedOnStyles = Vale, RISCV-Vale, AsciiDoc #Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. -TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[) +#TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[) # Match INI files. See: https://docs.errata.ai/vale/scoping #[*.ini] From 9b0f66861f51d0b8748e17ce90b62a48f8a52180 Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 12:55:48 -0400 Subject: [PATCH 21/33] Remove local stylespath --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 50db9df..889d2c4 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,4 +1,4 @@ -StylesPath = .github/styles +#StylesPath = .github/styles #MinAlertLevel = suggestion #IgnoredScopes = code, tt, img, url, a, body.id From 0f20ad98c8eb51bc48c931f572c05d195036e1f8 Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 13:06:15 -0400 Subject: [PATCH 22/33] Remove Vocab line --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 889d2c4..8d0f5b6 100644 --- a/.vale.ini +++ b/.vale.ini @@ -7,7 +7,7 @@ #Packages = RedHat Packages = AsciiDoc,https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip, https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip -Vocab = riscv-vocab +#Vocab = riscv-vocab #[*.adoc] #BasedOnStyles = AsciiDoc From 8d27645646a26bf5a4a6dc72895e0fbe2fe6059a Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 14:37:10 -0400 Subject: [PATCH 23/33] Adding vocab --- .vale.ini | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.vale.ini b/.vale.ini index 8d0f5b6..175391e 100644 --- a/.vale.ini +++ b/.vale.ini @@ -7,10 +7,10 @@ #Packages = RedHat Packages = AsciiDoc,https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip, https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip -#Vocab = riscv-vocab +Vocab = riscv-vocab #[*.adoc] -#BasedOnStyles = AsciiDoc +#BasedOnStyles = AsciiDoc, riscv #[*.md] #BasedOnStyles = Vale, RISCV-Vale, AsciiDoc From 20b68b462f770c3aa3934cbda720e87266452718 Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 14:40:02 -0400 Subject: [PATCH 24/33] Remove Vocab --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 175391e..dd67edc 100644 --- a/.vale.ini +++ b/.vale.ini @@ -7,7 +7,7 @@ #Packages = RedHat Packages = AsciiDoc,https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip, https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip -Vocab = riscv-vocab +#Vocab = riscv-vocab #[*.adoc] #BasedOnStyles = AsciiDoc, riscv From c15869b7d270159f0bf025823bccf227490451dd Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 15:20:05 -0400 Subject: [PATCH 25/33] Adding another spelling mistake --- src/a_few_basics.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/src/a_few_basics.adoc b/src/a_few_basics.adoc index 0c0b509..101b057 100644 --- a/src/a_few_basics.adoc +++ b/src/a_few_basics.adoc @@ -1,6 +1,7 @@ [[a_few_basics]] == AsciiDoc basics +mikroarkitecture pseudoinstruction pseudo-instruction CsR From 70a15beec2fb0b7e06fa89c45290612e7bbedb1c Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 24 Mar 2025 15:23:41 -0400 Subject: [PATCH 26/33] Add another spelling mistake --- src/a_few_basics.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/src/a_few_basics.adoc b/src/a_few_basics.adoc index 101b057..2a1b8c9 100644 --- a/src/a_few_basics.adoc +++ b/src/a_few_basics.adoc @@ -1,6 +1,7 @@ [[a_few_basics]] == AsciiDoc basics +lkasdjfhjklsdhfjkh mikroarkitecture pseudoinstruction pseudo-instruction From 33f9fe19c257e7c309796c734d4a18cad07cf822 Mon Sep 17 00:00:00 2001 From: wmat Date: Tue, 25 Mar 2025 15:33:18 -0400 Subject: [PATCH 27/33] Setting the run types --- .github/workflows/vale-using-reusable.yml | 5 ++++- .vale.ini | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/workflows/vale-using-reusable.yml b/.github/workflows/vale-using-reusable.yml index c2249bd..4abc26a 100644 --- a/.github/workflows/vale-using-reusable.yml +++ b/.github/workflows/vale-using-reusable.yml @@ -1,6 +1,9 @@ name: Linting with Vale using Reusable Config #on: [pull_request] -on: [push,pull_request] +on: + pull_request: + types: [opened,edited] + push: jobs: call-reusable-vale-workflow-in-riscv-vale-repo: diff --git a/.vale.ini b/.vale.ini index dd67edc..fbdb288 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,4 +1,4 @@ -#StylesPath = .github/styles +StylesPath = .github/styles #MinAlertLevel = suggestion #IgnoredScopes = code, tt, img, url, a, body.id From ef0b451453445edc8897c2c663faeacb7375bb98 Mon Sep 17 00:00:00 2001 From: wmat Date: Wed, 26 Mar 2025 08:31:56 -0400 Subject: [PATCH 28/33] Adding styles dir to git --- .../vocabularies/riscv-vocab/accept.txt | 1 + .../vocabularies/riscv-vocab/reject.txt | 1 + .github/styles/riscv/CapitalizeCSR.yml | 7 +++++ .github/styles/riscv/SpellingRV.yml | 29 +++++++++++++++++++ 4 files changed, 38 insertions(+) create mode 100644 .github/styles/config/vocabularies/riscv-vocab/accept.txt create mode 100644 .github/styles/config/vocabularies/riscv-vocab/reject.txt create mode 100644 .github/styles/riscv/CapitalizeCSR.yml create mode 100644 .github/styles/riscv/SpellingRV.yml diff --git a/.github/styles/config/vocabularies/riscv-vocab/accept.txt b/.github/styles/config/vocabularies/riscv-vocab/accept.txt new file mode 100644 index 0000000..f45b70f --- /dev/null +++ b/.github/styles/config/vocabularies/riscv-vocab/accept.txt @@ -0,0 +1 @@ +pseudoinstruction \ No newline at end of file diff --git a/.github/styles/config/vocabularies/riscv-vocab/reject.txt b/.github/styles/config/vocabularies/riscv-vocab/reject.txt new file mode 100644 index 0000000..724181e --- /dev/null +++ b/.github/styles/config/vocabularies/riscv-vocab/reject.txt @@ -0,0 +1 @@ +pseudo-instruction \ No newline at end of file diff --git a/.github/styles/riscv/CapitalizeCSR.yml b/.github/styles/riscv/CapitalizeCSR.yml new file mode 100644 index 0000000..6e570b1 --- /dev/null +++ b/.github/styles/riscv/CapitalizeCSR.yml @@ -0,0 +1,7 @@ +--- +extends: existence +scope: raw +level: error +message: "The acronym CSR must always be capitalized." +raw: + - '\b(?!(CSR)\b)[cC][sS][rR]\b' \ No newline at end of file diff --git a/.github/styles/riscv/SpellingRV.yml b/.github/styles/riscv/SpellingRV.yml new file mode 100644 index 0000000..f5852d4 --- /dev/null +++ b/.github/styles/riscv/SpellingRV.yml @@ -0,0 +1,29 @@ +#file: noinspection IncorrectFormatting +--- +extends: spelling +level: warning +link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/spelling/ +message: "Verify the word '%s'. It is not in the American English spelling dictionary used by Vale." +# A "filter" is a case-sensitive regular expression specifying words to ignore during spell checking. +# Spelling rule applies to individual words +# There is no need to add plural forms (s?) to the regex +filters: + - "[mM]icroarchitecture" + - "[mM]icroarchitectural" + - "IEEE" + - "RISC" + - "RISC-V" + - "IEC" + - "[vV]irtualize" + - "virtualization" + - "SOAR" + - "SPUR" + - "[mM]icrocontroller" + - "FPGA" + - "[pP]seudocode" + - "[hH]alfword" + - "[dD]oubleword" + - "[bB]itwise" + - "[bB]oolean" + - "[sS]box" + - "[eE]ndian" From 44e55cb040c8f72eb461d9d4d6c1257dd5dd49c5 Mon Sep 17 00:00:00 2001 From: wmat Date: Wed, 26 Mar 2025 08:50:38 -0400 Subject: [PATCH 29/33] Do I need a space between nested packages --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index fbdb288..1f22002 100644 --- a/.vale.ini +++ b/.vale.ini @@ -6,7 +6,7 @@ StylesPath = .github/styles #SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock #Packages = RedHat -Packages = AsciiDoc,https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip, https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip +Packages = AsciiDoc, https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip, https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip #Vocab = riscv-vocab #[*.adoc] From 6349085dbaa4f1273fd1e3c63d12967149c70ab9 Mon Sep 17 00:00:00 2001 From: wmat Date: Wed, 26 Mar 2025 08:55:26 -0400 Subject: [PATCH 30/33] Trying with just AsciiDoc package --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 1f22002..18d40ba 100644 --- a/.vale.ini +++ b/.vale.ini @@ -6,7 +6,7 @@ StylesPath = .github/styles #SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock #Packages = RedHat -Packages = AsciiDoc, https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip, https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip +Packages = AsciiDoc #Vocab = riscv-vocab #[*.adoc] From 61321ac2bc4909b1e51eb8811bbce929a700b5e6 Mon Sep 17 00:00:00 2001 From: wmat Date: Wed, 26 Mar 2025 14:21:43 -0400 Subject: [PATCH 31/33] Remove package, defer to reusable workflow. --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 18d40ba..84510ad 100644 --- a/.vale.ini +++ b/.vale.ini @@ -6,7 +6,7 @@ StylesPath = .github/styles #SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock #Packages = RedHat -Packages = AsciiDoc +#Packages = AsciiDoc #Vocab = riscv-vocab #[*.adoc] From 9790b9de75f9cc073f251a3838f162844819c873 Mon Sep 17 00:00:00 2001 From: wmat Date: Wed, 26 Mar 2025 14:24:58 -0400 Subject: [PATCH 32/33] Add packages --- .vale.ini | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.vale.ini b/.vale.ini index 84510ad..4b580bd 100644 --- a/.vale.ini +++ b/.vale.ini @@ -5,9 +5,9 @@ StylesPath = .github/styles #SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock -#Packages = RedHat -#Packages = AsciiDoc -#Vocab = riscv-vocab +Packages = AsciiDoc, https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip, https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip + +Vocab = riscv-vocab #[*.adoc] #BasedOnStyles = AsciiDoc, riscv From fd0b066fd03317a13420b3c69e9bfbcedf7d50d6 Mon Sep 17 00:00:00 2001 From: wmat Date: Tue, 22 Apr 2025 13:26:11 -0400 Subject: [PATCH 33/33] More testing --- src/a_few_basics.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/a_few_basics.adoc b/src/a_few_basics.adoc index 2a1b8c9..689eedf 100644 --- a/src/a_few_basics.adoc +++ b/src/a_few_basics.adoc @@ -1,13 +1,12 @@ [[a_few_basics]] == AsciiDoc basics -lkasdjfhjklsdhfjkh -mikroarkitecture pseudoinstruction pseudo-instruction CsR cSR CSR +csr AsciiDoc is fully documented, and its documentation is actively maintained. This document contains some information on AsciiDoc markup to get you started.