Martin Roth has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/46287 )
Change subject: Makefile: Remove CONFIG_MAINBOARD_PART_NUMBER from doxyplatform ......................................................................
Makefile: Remove CONFIG_MAINBOARD_PART_NUMBER from doxyplatform
The CONFIG_MAINBOARD_PART_NUMBER string can have characters in it that don't work in the doxyplatform make script under sh, so remove it and just use the CONFIG_MAINBOARD_DIR value instead.
The spaces in the "QEMU x86 i440fx/piix4" platform are one example of this.
Signed-off-by: Martin Roth martin@coreboot.org Change-Id: I10bc6a8a245a34e89c859ff46835bde35aaa4286 --- M Makefile 1 file changed, 2 insertions(+), 2 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/87/46287/1
diff --git a/Makefile b/Makefile index 2705c66..4f7f45d 100644 --- a/Makefile +++ b/Makefile @@ -440,10 +440,10 @@ doxyplatform doxygen_platform: $(obj)/project_filelist.txt echo echo "Building doxygen documentation for $(CONFIG_MAINBOARD_PART_NUMBER)" - export DOXYGEN_OUTPUT_DIR="$(DOXYGEN_OUTPUT_DIR)/$(CONFIG_MAINBOARD_VENDOR)/$(CONFIG_MAINBOARD_PART_NUMBER)"; \ + export DOXYGEN_OUTPUT_DIR="$(DOXYGEN_OUTPUT_DIR)/$(CONFIG_MAINBOARD_DIR)"; \ mkdir -p "$$DOXYGEN_OUTPUT_DIR"; \ export DOXYFILES="$$(cat $(obj)/project_filelist.txt | grep -v '.ld$$' | sed 's/.aml/.dsl/' | tr '\n' ' ')"; \ - export DOXYGEN_PLATFORM="$(CONFIG_MAINBOARD_DIR) ($(CONFIG_MAINBOARD_PART_NUMBER)) version $(KERNELVERSION)"; \ + export DOXYGEN_PLATFORM="$(CONFIG_MAINBOARD_DIR) version $(KERNELVERSION)"; \ $(DOXYGEN) Documentation/doxygen/Doxyfile.coreboot_platform
doxyclean: doxygen-clean
Marc Jones has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/46287 )
Change subject: Makefile: Remove CONFIG_MAINBOARD_PART_NUMBER from doxyplatform ......................................................................
Patch Set 1:
(1 comment)
https://review.coreboot.org/c/coreboot/+/46287/1//COMMIT_MSG Commit Message:
https://review.coreboot.org/c/coreboot/+/46287/1//COMMIT_MSG@14 PS1, Line 14: this. This is what generates: https://doc.coreboot.org/mainboard/index.html ?
What would it look like with this change?
Martin Roth has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/46287 )
Change subject: Makefile: Remove CONFIG_MAINBOARD_PART_NUMBER from doxyplatform ......................................................................
Patch Set 1:
(1 comment)
https://review.coreboot.org/c/coreboot/+/46287/1//COMMIT_MSG Commit Message:
https://review.coreboot.org/c/coreboot/+/46287/1//COMMIT_MSG@14 PS1, Line 14: this.
This is what generates: https://doc.coreboot.org/mainboard/index.html ? […]
No, I think all of those are done by hand. That's not doxygen documentation.
Hello Marc Jones, build bot (Jenkins), Patrick Georgi, Stefan Reinauer, Paul Fagerburg, Felix Held,
I'd like you to reexamine a change. Please visit
https://review.coreboot.org/c/coreboot/+/46287
to look at the new patch set (#2).
Change subject: Makefile: Remove possibly illegal characters from doxyplatform ......................................................................
Makefile: Remove possibly illegal characters from doxyplatform
The CONFIG_MAINBOARD_PART_NUMBER string can have characters in it that don't work in the doxyplatform make script under sh, so change any non-alphanumeric characters to an underscore.
Also strip all the quotes - they aren't needed.
The spaces in the "QEMU x86 i440fx/piix4" platform are one example of this.
Signed-off-by: Martin Roth martin@coreboot.org Change-Id: I10bc6a8a245a34e89c859ff46835bde35aaa4286 --- M Makefile 1 file changed, 2 insertions(+), 2 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/87/46287/2
Paul Fagerburg has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/46287 )
Change subject: Makefile: Remove possibly illegal characters from doxyplatform ......................................................................
Patch Set 3: Code-Review+1
Angel Pons has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/46287 )
Change subject: Makefile: Remove possibly illegal characters from doxyplatform ......................................................................
Patch Set 3: Code-Review+1
Patrick Georgi has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/46287 )
Change subject: Makefile: Remove possibly illegal characters from doxyplatform ......................................................................
Patch Set 3:
(1 comment)
https://review.coreboot.org/c/coreboot/+/46287/3/Makefile File Makefile:
https://review.coreboot.org/c/coreboot/+/46287/3/Makefile@443 PS3, Line 443: sed 's|[^A-Za-z0-9/]|_|g' How about
tr -c '[[:alnum:]]' '_'
Martin Roth has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/46287 )
Change subject: Makefile: Remove possibly illegal characters from doxyplatform ......................................................................
Patch Set 3:
(1 comment)
https://review.coreboot.org/c/coreboot/+/46287/3/Makefile File Makefile:
https://review.coreboot.org/c/coreboot/+/46287/3/Makefile@443 PS3, Line 443: sed 's|[^A-Za-z0-9/]|_|g'
How about […]
I want to skip slashes in the path as well.
Paul Fagerburg has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/46287 )
Change subject: Makefile: Remove possibly illegal characters from doxyplatform ......................................................................
Patch Set 3: Code-Review+2
Marshall Dawson has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/46287 )
Change subject: Makefile: Remove possibly illegal characters from doxyplatform ......................................................................
Patch Set 3: Code-Review+2
Felix Held has submitted this change. ( https://review.coreboot.org/c/coreboot/+/46287 )
Change subject: Makefile: Remove possibly illegal characters from doxyplatform ......................................................................
Makefile: Remove possibly illegal characters from doxyplatform
The CONFIG_MAINBOARD_PART_NUMBER string can have characters in it that don't work in the doxyplatform make script under sh, so change any non-alphanumeric characters to an underscore.
Also strip all the quotes - they aren't needed.
The spaces in the "QEMU x86 i440fx/piix4" platform are one example of this.
Signed-off-by: Martin Roth martin@coreboot.org Change-Id: I10bc6a8a245a34e89c859ff46835bde35aaa4286 Reviewed-on: https://review.coreboot.org/c/coreboot/+/46287 Tested-by: build bot (Jenkins) no-reply@coreboot.org Reviewed-by: Angel Pons th3fanbus@gmail.com Reviewed-by: Paul Fagerburg pfagerburg@chromium.org Reviewed-by: Marshall Dawson marshalldawson3rd@gmail.com --- M Makefile 1 file changed, 2 insertions(+), 2 deletions(-)
Approvals: build bot (Jenkins): Verified Marshall Dawson: Looks good to me, approved Angel Pons: Looks good to me, but someone else must approve Paul Fagerburg: Looks good to me, approved
diff --git a/Makefile b/Makefile index 2705c66..1b7cb9b 100644 --- a/Makefile +++ b/Makefile @@ -440,10 +440,10 @@ doxyplatform doxygen_platform: $(obj)/project_filelist.txt echo echo "Building doxygen documentation for $(CONFIG_MAINBOARD_PART_NUMBER)" - export DOXYGEN_OUTPUT_DIR="$(DOXYGEN_OUTPUT_DIR)/$(CONFIG_MAINBOARD_VENDOR)/$(CONFIG_MAINBOARD_PART_NUMBER)"; \ + export DOXYGEN_OUTPUT_DIR="$$( echo $(DOXYGEN_OUTPUT_DIR)/$(call strip_quotes, $(CONFIG_MAINBOARD_VENDOR))_$(call strip_quotes, $(CONFIG_MAINBOARD_PART_NUMBER)) | sed 's|[^A-Za-z0-9/]|_|g' )"; \ mkdir -p "$$DOXYGEN_OUTPUT_DIR"; \ export DOXYFILES="$$(cat $(obj)/project_filelist.txt | grep -v '.ld$$' | sed 's/.aml/.dsl/' | tr '\n' ' ')"; \ - export DOXYGEN_PLATFORM="$(CONFIG_MAINBOARD_DIR) ($(CONFIG_MAINBOARD_PART_NUMBER)) version $(KERNELVERSION)"; \ + export DOXYGEN_PLATFORM="$(call strip_quotes, $(CONFIG_MAINBOARD_DIR)) ($(call strip_quotes, $(CONFIG_MAINBOARD_PART_NUMBER))) version $(KERNELVERSION)"; \ $(DOXYGEN) Documentation/doxygen/Doxyfile.coreboot_platform
doxyclean: doxygen-clean