Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 3794f3e8 authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds
Browse files

docsrc: build Documentation/ sources 



Currently source files in the Documentation/ sub-dir can easily bit-rot
since they are not generally buildable, either because they are hidden in
text files or because there are no Makefile rules for them.  This needs to
be fixed so that the source files remain usable and good examples of code
instead of bad examples.

Add the ability to build source files that are in the Documentation/ dir.
Add to Kconfig as "BUILD_DOCSRC" config symbol.

Use "CONFIG_BUILD_DOCSRC=1 make ..." to build objects from the
Documentation/ sources.  Or enable BUILD_DOCSRC in the *config system.
However, this symbol depends on HEADERS_CHECK since the header files need
to be installed (for userspace builds).

Built (using cross-tools) for x86-64, i386, alpha, ia64, sparc32,
sparc64, powerpc, sh, m68k, & mips.

Signed-off-by: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Reviewed-by: default avatarSam Ravnborg <sam@ravnborg.org>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent bc2aa80e

Documentation/DocBook/Makefile

+7 −0
Original line number Diff line number Diff line
@@ -102,6 +102,13 @@ C-procfs-example = procfs_example.xml 
C-procfs-example2 = $(addprefix $(obj)/,$(C-procfs-example))

$(obj)/procfs-guide.xml: $(C-procfs-example2)



# List of programs to build

##oops, this is a kernel module::hostprogs-y := procfs_example

obj-m += procfs_example.o



# Tell kbuild to always build the programs

always := $(hostprogs-y)



notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \

		   exit 1

db2xtemplate = db2TYPE -o $(dir $@) $<

Documentation/Makefile

0 → 100644
+3 −0
Original line number Diff line number Diff line 
obj-m := DocBook/ accounting/ auxdisplay/ connector/ \

	filesystems/configfs/ ia64/ networking/ \

	pcmcia/ spi/ video4linux/ vm/ watchdog/src/

Documentation/accounting/Makefile

0 → 100644
+10 −0
Original line number Diff line number Diff line 
# kbuild trick to avoid linker error. Can be omitted if a module is built.

obj- := dummy.o



# List of programs to build

hostprogs-y := getdelays



# Tell kbuild to always build the programs

always := $(hostprogs-y)



HOSTCFLAGS_getdelays.o += -I$(objtree)/usr/include

Documentation/auxdisplay/Makefile

0 → 100644
+10 −0
Original line number Diff line number Diff line 
# kbuild trick to avoid linker error. Can be omitted if a module is built.

obj- := dummy.o



# List of programs to build

hostprogs-y := cfag12864b-example



# Tell kbuild to always build the programs

always := $(hostprogs-y)



HOSTCFLAGS_cfag12864b-example.o += -I$(objtree)/usr/include

Documentation/connector/Makefile

0 → 100644
+11 −0
Original line number Diff line number Diff line 
ifneq ($(CONFIG_CONNECTOR),)

obj-m += cn_test.o

endif



# List of programs to build

hostprogs-y := ucon



# Tell kbuild to always build the programs

always := $(hostprogs-y)



HOSTCFLAGS_ucon.o += -I$(objtree)/usr/include