Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix doc build issue in ERROR_CODES.md #25894

Merged
merged 4 commits into from
Mar 30, 2023
Merged

Fix doc build issue in ERROR_CODES.md #25894

merged 4 commits into from
Mar 30, 2023

Conversation

greg-fer
Copy link
Contributor

@greg-fer greg-fer commented Mar 30, 2023 •
edited
Loading

The PR #25888 was merged with red doc build, which introduced a doc build issue to master and prevents doc deployment.

To fix the issue, this PR is:

  • Removing the incorrect Markdown formatting in the ERROR_CODE.md ToC generated by the error_table.py script.
  • Removing the // comments at the beginning and the end of the file (and related lines in the script), which should not be needed, as the script is already excluded by line 68 in .spellcheck.yml

Also cherry-picked the commit from #25893

@github-actions github-actions bot added documentation Improvements or additions to documentation scripts labels Mar 30, 2023
@github-actions
Copy link

PR #25894: Size comparison from a27bc8c to 7fbe20f

Increases (1 build for cc32xx)
platform target config section a27bc8c 7fbe20f change % change
cc32xx lock CC3235SF_LAUNCHXL .debug_info 20310043 20310044 1 0.0
Full report (1 build for cc32xx)
platform target config section a27bc8c 7fbe20f change % change
cc32xx lock CC3235SF_LAUNCHXL 0 0 0 0.0
(read only) 645769 645769 0 0.0
(read/write) 203848 203848 0 0.0
.ARM.attributes 44 44 0 0.0
.ARM.exidx 8 8 0 0.0
.bss 197248 197248 0 0.0
.comment 194 194 0 0.0
.data 1480 1480 0 0.0
.debug_abbrev 933102 933102 0 0.0
.debug_aranges 87704 87704 0 0.0
.debug_frame 301596 301596 0 0.0
.debug_info 20310043 20310044 1 0.0
.debug_line 2681003 2681003 0 0.0
.debug_loc 2827360 2827360 0 0.0
.debug_ranges 286352 286352 0 0.0
.debug_str 3041144 3041144 0 0.0
.ramVecs 780 780 0 0.0
.resetVecs 64 64 0 0.0
.rodata 105953 105953 0 0.0
.shstrtab 232 232 0 0.0
.stab 204 204 0 0.0
.stabstr 441 441 0 0.0
.stack 2048 2048 0 0.0
.strtab 380543 380543 0 0.0
.symtab 257472 257472 0 0.0
.text 537696 537696 0 0.0

@gautesl gautesl mentioned this pull request Mar 30, 2023
Merged
@github-actions
Copy link

PR #25894: Size comparison from a27bc8c to e29498a

Decreases (1 build for cc32xx)
platform target config section a27bc8c e29498a change % change
cc32xx lock CC3235SF_LAUNCHXL .debug_info 20310043 20310042 -1 -0.0
Full report (1 build for cc32xx)
platform target config section a27bc8c e29498a change % change
cc32xx lock CC3235SF_LAUNCHXL 0 0 0 0.0
(read only) 645769 645769 0 0.0
(read/write) 203848 203848 0 0.0
.ARM.attributes 44 44 0 0.0
.ARM.exidx 8 8 0 0.0
.bss 197248 197248 0 0.0
.comment 194 194 0 0.0
.data 1480 1480 0 0.0
.debug_abbrev 933102 933102 0 0.0
.debug_aranges 87704 87704 0 0.0
.debug_frame 301596 301596 0 0.0
.debug_info 20310043 20310042 -1 -0.0
.debug_line 2681003 2681003 0 0.0
.debug_loc 2827360 2827360 0 0.0
.debug_ranges 286352 286352 0 0.0
.debug_str 3041144 3041144 0 0.0
.ramVecs 780 780 0 0.0
.resetVecs 64 64 0 0.0
.rodata 105953 105953 0 0.0
.shstrtab 232 232 0 0.0
.stab 204 204 0 0.0
.stabstr 441 441 0 0.0
.stack 2048 2048 0 0.0
.strtab 380543 380543 0 0.0
.symtab 257472 257472 0 0.0
.text 537696 537696 0 0.0

greg-fer and others added 4 commits March 30, 2023 14:33
@greg-fer
edit_table.py: fix issue breaking SDK doc build
0532e71 
Removed period from the ASN.1 entry as it is breaking markdown formatting and the whole SDK doc build.
Checked against headers in src\lib\asn1, which allow ASN1 without the period.

Signed-off-by: Grzegorz Ferenc <[email protected]>
@greg-fer
error_table.py: remove lines creating Myst issue
75692d9 
Removed lines that caused the docbuild to fail with
"src/ERROR_CODES.md:259: WARNING: Duplicate reference definition:
// [myst.duplicate_def]" issue.

These lines excluded ERROR_CODES.md from spellchecking, but this
exclusion is already ensured by line 68 in .spellcheck.yml.

Signed-off-by: Grzegorz Ferenc <[email protected]>
@restyled-commits @greg-fer
Restyled by autopep8
28a060c
@gautesl @greg-fer
doc: Fix dependancy version
b40c439 
Fix version of dependancy pydata-sphinx-theme to 0.13.1
since v0.13.2 introduced breaking changes.

Signed-off-by: Gaute Svanes Lunde <[email protected]>
@greg-fer greg-fer force-pushed the doc_fix_doc_build_issue_in_error_codes branch from e29498a to b40c439 Compare March 30, 2023 12:33
@andy31415 andy31415 merged commit d431791 into project-chip:master Mar 30, 2023
bzbarsky-apple
bzbarsky-apple reviewed Mar 30, 2023
View reviewed changes
scripts/error_table.py
@@ -134,14 +134,11 @@ def main():
"src/lib/core/CHIPError.h": ErrorDescriptor(section="SDK Core", code_range=0x000, macro_regex=r"^#define\s+(?P<name>[_A-Z0-9]+)\s+CHIP(_CORE)?_ERROR[(](?P<code>(0x[a-fA-F0-9]+)|\d+)[)]"),
"src/inet/InetError.h": ErrorDescriptor(section="SDK Inet Layer", code_range=0x100, macro_regex=r"^#define\s+(?P<name>[_A-Z0-9]+)\s+CHIP_INET_ERROR[(](?P<code>(0x[a-fA-F0-9]+)|\d+)[)]"),
"src/include/platform/CHIPDeviceError.h": ErrorDescriptor(section="SDK Device Layer", code_range=0x200, macro_regex=r"^#define\s+(?P<name>[_A-Z0-9]+)\s+CHIP_DEVICE_ERROR[(](?P<code>(0x[a-fA-F0-9]+)|\d+)[)]"),
"src/lib/asn1/ASN1Error.h": ErrorDescriptor(section="ASN.1 Layer", code_range=0x300, macro_regex=r"^#define\s+(?P<name>[_A-Z0-9]+)\s+CHIP_ASN1_ERROR[(](?P<code>(0x[a-fA-F0-9]+)|\d+)[)]"),
"src/lib/asn1/ASN1Error.h": ErrorDescriptor(section="ASN1 Layer", code_range=0x300, macro_regex=r"^#define\s+(?P<name>[_A-Z0-9]+)\s+CHIP_ASN1_ERROR[(](?P<code>(0x[a-fA-F0-9]+)|\d+)[)]"),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"ASN.1" is the right spelling, though!

@bzbarsky-apple
Copy link
Contributor

@greg-fer And note that before the changes from #25888 that table of contents line in the .md was:

-  [ASN.1 Layer errors: range `0x300..0x3FF`](#asn.1-layer-errors)

and the header had "ASN.1" in it...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bzbarsky-apple bzbarsky-apple bzbarsky-apple left review comments

@andy31415 andy31415 andy31415 approved these changes

@amitnj amitnj Awaiting requested review from amitnj

@anush-apple anush-apple Awaiting requested review from anush-apple

@arkq arkq Awaiting requested review from arkq

@carol-apple carol-apple Awaiting requested review from carol-apple

@chrisdecenzo chrisdecenzo Awaiting requested review from chrisdecenzo

@chshu chshu Awaiting requested review from chshu

@chulspro chulspro Awaiting requested review from chulspro

@cliffamzn cliffamzn Awaiting requested review from cliffamzn

@Damian-Nordic Damian-Nordic Awaiting requested review from Damian-Nordic

@dhrishi dhrishi Awaiting requested review from dhrishi

@electrocucaracha electrocucaracha Awaiting requested review from electrocucaracha

@emargolis emargolis Awaiting requested review from emargolis

@franck-apple franck-apple Awaiting requested review from franck-apple

@gjc13 gjc13 Awaiting requested review from gjc13

@harimau-qirex harimau-qirex Awaiting requested review from harimau-qirex

@harsha-rajendran harsha-rajendran Awaiting requested review from harsha-rajendran

@hawk248 hawk248 Awaiting requested review from hawk248

@jelderton jelderton Awaiting requested review from jelderton

@jepenven-silabs jepenven-silabs Awaiting requested review from jepenven-silabs

@jmartinez-silabs jmartinez-silabs Awaiting requested review from jmartinez-silabs

@jmeg-sfy jmeg-sfy Awaiting requested review from jmeg-sfy

@joonhaengHeo joonhaengHeo Awaiting requested review from joonhaengHeo

@jtung-apple jtung-apple Awaiting requested review from jtung-apple

@kcoppock kcoppock Awaiting requested review from kcoppock

@kkasperczyk-no kkasperczyk-no Awaiting requested review from kkasperczyk-no

@ksperling-apple ksperling-apple Awaiting requested review from ksperling-apple

@lazarkov lazarkov Awaiting requested review from lazarkov

@lpbeliveau-silabs lpbeliveau-silabs Awaiting requested review from lpbeliveau-silabs

@LuDuda LuDuda Awaiting requested review from LuDuda

@mlepage-google mlepage-google Awaiting requested review from mlepage-google

@mrjerryjohns mrjerryjohns Awaiting requested review from mrjerryjohns

@msandstedt msandstedt Awaiting requested review from msandstedt

@mspang mspang Awaiting requested review from mspang

@nivi-apple nivi-apple Awaiting requested review from nivi-apple

@saurabhst saurabhst Awaiting requested review from saurabhst

@selissia selissia Awaiting requested review from selissia

@sharadb-amazon sharadb-amazon Awaiting requested review from sharadb-amazon

@tecimovic tecimovic Awaiting requested review from tecimovic

@turon turon Awaiting requested review from turon

@vijs vijs Awaiting requested review from vijs

@vivien-apple vivien-apple Awaiting requested review from vivien-apple

@woody-apple woody-apple Awaiting requested review from woody-apple

@xylophone21 xylophone21 Awaiting requested review from xylophone21

@younghak-hwang younghak-hwang Awaiting requested review from younghak-hwang

@yufengwangca yufengwangca Awaiting requested review from yufengwangca

@yunhanw-google yunhanw-google Awaiting requested review from yunhanw-google

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation fast track review - pending scripts
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@greg-fer @bzbarsky-apple @andy31415 @restyled-commits @gautesl