Skip to contentSkip to conversation

docbook: make cleandocs

PATCH? Applied Randy Dunlap 2 participants 4 messages Apr 10, 2009

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

Hi Sam,

"make clean" cleans DocBook generated files, but I would like a way to clean _only_ those generated files. Something like the patch below, except that it doesn't work. :(

Can you give me ideas of how to fix it, please?

Thanks,
---
~Randy

From: Randy Dunlap <[email protected]>

Add a 'make cleandocs' target to clean up all generated DocBook files.

---
 Documentation/DocBook/Makefile |   15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)
Documentation/DocBook/Makefile +12 -3
@@ -31,7 +31,7 @@ PS_METHOD	= $(prefer-db2x)
 
 ###
 # The targets that may be used.
-PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs
+PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs
 
 BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
 xmldocs: $(BOOKS)
@@ -213,11 +213,12 @@ silent_gen_xml = :
 dochelp:
 	@echo  ' Linux kernel internal documentation in different formats:'
 	@echo  '  htmldocs        - HTML'
-	@echo  '  installmandocs  - install man pages generated by mandocs'
-	@echo  '  mandocs         - man pages'
 	@echo  '  pdfdocs         - PDF'
 	@echo  '  psdocs          - Postscript'
 	@echo  '  xmldocs         - XML DocBook'
+	@echo  '  mandocs         - man pages'
+	@echo  '  installmandocs  - install man pages generated by mandocs'
+	@echo  '  cleandocs       - clean all generated DocBook files'
 
 ###
 # Temporary files left by various tools
@@ -235,6 +236,14 @@ clean-files := $(DOCBOOKS) \
 
 clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
 
+cleandocs:
+	echo "clean-files: $(clean-files)"
+	echo "clean-dirs: $(clean-dirs)"
+	cd Documentation/DocBook
+	rm -f $(clean-files)
+	rm -rf $(clean-dirs)
+	cd ../..
+
 # Declare the contents of the .PHONY variable as phony.  We keep that
 # information in a variable se we can use it in if_changed and friends.
 
#1 lore raw
Quoted 52 lines · Randy Dunlap

Hi Sam,

"make clean" cleans DocBook generated files, but I would like a way to clean _only_ those generated files. Something like the patch below, except that it doesn't work. :(

Can you give me ideas of how to fix it, please?

Thanks,
---
~Randy

From: Randy Dunlap <[email protected]>

Add a 'make cleandocs' target to clean up all generated DocBook files.

---
 Documentation/DocBook/Makefile |   15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)
Documentation/DocBook/Makefile +4 -3
@@ -31,7 +31,7 @@ PS_METHOD	= $(prefer-db2x)
 
 ###
 # The targets that may be used.
-PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs
+PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs
 
 BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
 xmldocs: $(BOOKS)
@@ -213,11 +213,12 @@ silent_gen_xml = :
 dochelp:
 	@echo  ' Linux kernel internal documentation in different formats:'
 	@echo  '  htmldocs        - HTML'
-	@echo  '  installmandocs  - install man pages generated by mandocs'
-	@echo  '  mandocs         - man pages'
 	@echo  '  pdfdocs         - PDF'
 	@echo  '  psdocs          - Postscript'
 	@echo  '  xmldocs         - XML DocBook'
+	@echo  '  mandocs         - man pages'
+	@echo  '  installmandocs  - install man pages generated by mandocs'
+	@echo  '  cleandocs       - clean all generated DocBook files'
 
 ###
 # Temporary files left by various tools

Documentation/DocBook/Makefile clean-files := $(DOCBOOKS) \ · line 245

Quoted 10 lines
Documentation/DocBook/Makefile +7 -0
@@ -235,6 +236,14 @@ clean-files := $(DOCBOOKS) \
 
 clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
 
+cleandocs:
+	echo "clean-files: $(clean-files)"
+	echo "clean-dirs: $(clean-dirs)"
+	cd Documentation/DocBook
+	rm -f $(clean-files)
+	rm -rf $(clean-dirs)
+	cd ../..

Each command are executed in their own shell. So the "cd Documentation/DocBook" will have no effect. You need to do something like:

	cd Documentation/DocBook && rm -f $(clean-files) && rm -rf $(clean-dirs)

Or the one I would prefer:

	rm -f $(call objectify, $(clean-files))
	rm -rf $(call objectify, $(clean-dirs))

In the command section of the above rule.

Sam

#2 lore raw

PATCH v2 1/1 docbook: make cleandocs

From: Randy Dunlap <[email protected]>

Add a 'make cleandocs' target to clean up all generated DocBook files.

---
 Documentation/DocBook/Makefile |   11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)
Documentation/DocBook/Makefile +8 -3
@@ -31,7 +31,7 @@ PS_METHOD	= $(prefer-db2x)
 
 ###
 # The targets that may be used.
-PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs
+PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs
 
 BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
 xmldocs: $(BOOKS)
@@ -213,11 +213,12 @@ silent_gen_xml = :
 dochelp:
 	@echo  ' Linux kernel internal documentation in different formats:'
 	@echo  '  htmldocs        - HTML'
-	@echo  '  installmandocs  - install man pages generated by mandocs'
-	@echo  '  mandocs         - man pages'
 	@echo  '  pdfdocs         - PDF'
 	@echo  '  psdocs          - Postscript'
 	@echo  '  xmldocs         - XML DocBook'
+	@echo  '  mandocs         - man pages'
+	@echo  '  installmandocs  - install man pages generated by mandocs'
+	@echo  '  cleandocs       - clean all generated DocBook files'
 
 ###
 # Temporary files left by various tools
@@ -235,6 +236,10 @@ clean-files := $(DOCBOOKS) \
 
 clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
 
+cleandocs:
+	$(Q)rm -f $(call objectify, $(clean-files))
+	$(Q)rm -rf $(call objectify, $(clean-dirs))
+
 # Declare the contents of the .PHONY variable as phony.  We keep that
 # information in a variable se we can use it in if_changed and friends.
 
Signature · 1 line
~Randy
Applied
#3 lore raw
Quoted 4 lines · Randy Dunlap

From: Randy Dunlap <[email protected]>

Add a 'make cleandocs' target to clean up all generated DocBook files.

Applied,
Sam