forked from Minki/linux
d40d48e1f1
Adds the basis for rtla documentation. This patch also includes the rtla(1) man page. As suggested by Jonathan Corbet, we are placing these man pages at Documentation/tools/rtla, using rst format. It is not linked to the official documentation, though. The Makefile is based on bpftool's Documentation one. Link: https://lkml.kernel.org/r/5f510f3e962fc0cd531c43f5a815544dd720c3f2.1639158831.git.bristot@kernel.org Cc: Tao Zhou <tao.zhou@linux.dev> Cc: Ingo Molnar <mingo@redhat.com> Cc: Tom Zanussi <zanussi@kernel.org> Cc: Masami Hiramatsu <mhiramat@kernel.org> Cc: Juri Lelli <juri.lelli@redhat.com> Cc: Clark Williams <williams@redhat.com> Cc: John Kacur <jkacur@redhat.com> Cc: Peter Zijlstra <peterz@infradead.org> Cc: Thomas Gleixner <tglx@linutronix.de> Cc: Sebastian Andrzej Siewior <bigeasy@linutronix.de> Cc: Daniel Bristot de Oliveira <bristot@kernel.org> Cc: linux-rt-users@vger.kernel.org Cc: linux-trace-devel@vger.kernel.org Cc: linux-kernel@vger.kernel.org Suggested-by: Steven Rostedt <rostedt@goodmis.org> Suggested-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Daniel Bristot de Oliveira <bristot@kernel.org> Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
42 lines
916 B
Makefile
42 lines
916 B
Makefile
# SPDX-License-Identifier: GPL-2.0-only
|
|
# Based on bpftool's Documentation Makefile
|
|
|
|
INSTALL ?= install
|
|
RM ?= rm -f
|
|
RMDIR ?= rmdir --ignore-fail-on-non-empty
|
|
|
|
PREFIX ?= /usr/share
|
|
MANDIR ?= $(PREFIX)/man
|
|
MAN1DIR = $(MANDIR)/man1
|
|
|
|
MAN1_RST = $(wildcard rtla*.rst)
|
|
|
|
_DOC_MAN1 = $(patsubst %.rst,%.1,$(MAN1_RST))
|
|
DOC_MAN1 = $(addprefix $(OUTPUT),$(_DOC_MAN1))
|
|
|
|
RST2MAN_DEP := $(shell command -v rst2man 2>/dev/null)
|
|
RST2MAN_OPTS += --verbose
|
|
|
|
$(OUTPUT)%.1: %.rst
|
|
ifndef RST2MAN_DEP
|
|
$(error "rst2man not found, but required to generate man pages")
|
|
endif
|
|
rst2man $(RST2MAN_OPTS) $< > $@
|
|
|
|
man1: $(DOC_MAN1)
|
|
man: man1
|
|
|
|
clean:
|
|
$(RM) $(DOC_MAN1)
|
|
|
|
install: man
|
|
$(INSTALL) -d -m 755 $(DESTDIR)$(MAN1DIR)
|
|
$(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(MAN1DIR)
|
|
|
|
uninstall:
|
|
$(RM) $(addprefix $(DESTDIR)$(MAN1DIR)/,$(_DOC_MAN1))
|
|
$(RMDIR) $(DESTDIR)$(MAN1DIR)
|
|
|
|
.PHONY: man man1 clean install uninstall
|
|
.DEFAULT_GOAL := man
|