Linux-Trace-Devel Archive on lore.kernel.org
 help / color / Atom feed
From: Steven Rostedt <rostedt@goodmis.org>
To: Zamir SUN <sztsian@gmail.com>
Cc: linux-trace-devel@vger.kernel.org
Subject: Re: libtraceevent: make doc-install tries different file names than generated
Date: Fri, 9 Oct 2020 10:49:54 -0400
Message-ID: <20201009104954.0fd440b5@gandalf.local.home> (raw)
In-Reply-To: <7cdec98e-3184-4ddc-e78c-867a9650e636@gmail.com>

On Thu, 8 Oct 2020 17:50:19 +0800
Zamir SUN <sztsian@gmail.com> wrote:

> Hi,
> 
> When I try to compiling the document of libtraceevent with the fix I 
> mentioned in [1] applied, make doc-install fails with errors like
> 
> "/usr/bin/install: cannot stat 'libtraceevent-record_parse.3': No such 
> file or directory"
> 
> Checking the compiled documents I see a lot of tep_*.3 generated, and 
> some libtraceevent_*.html. However no libtraceevent_*.3.
> 
> $ ls Documentation/*3 | head
> Documentation/libtraceevent.3
> Documentation/tep_alloc.3
> Documentation/tep_clear_flag.3
> Documentation/tep_cmdline_pid.3
> Documentation/tep_data_comm_from_pid.3
> Documentation/tep_data_flags.3
> Documentation/tep_data_pid.3
> Documentation/tep_data_pid_from_comm.3
> Documentation/tep_data_preempt_count.3
> Documentation/tep_data_type.3
> ls Documentation/*html | head
> Documentation/libtraceevent-commands.html
> Documentation/libtraceevent-cpus.html
> Documentation/libtraceevent-endian_read.html
> Documentation/libtraceevent-event_find.html
> Documentation/libtraceevent-event_get.html
> Documentation/libtraceevent-event_list.html
> Documentation/libtraceevent-event_print.html
> Documentation/libtraceevent-field_find.html
> Documentation/libtraceevent-field_get_val.html
> Documentation/libtraceevent-field_print.html
> 
> I also tried to port the Makefile from trace-cmd/Documentation to the 
> document dir, and it still only generates tep_*.3 files, so I feel this 
> is not the issue with the patch from [1].
> 
> As for my local environment, I have xmlto and asciidoc installed[2], but 
> not asciidoctor. I expect asciidoc could generate the documentations 
> like what it did in trace-cmd before.
> 
> Any idea if this is issue with my environment or it's something that 
> need to be implemented in the Makefile?
>

Hi Zamir,

Thanks a lot for looking into this. I took your advice and reverted my
blind copy of the Makefiles, scripts and include headers, and instead
copied over their full history from the Linux kernel Tools directory.

You can see that update no (which now includes the utilities.mak as well).

Can you see if this patch fixes your current issue?

-- Steve

diff --git a/Documentation/Makefile b/Documentation/Makefile
index edb8623..3a981be 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -157,7 +157,7 @@ endif
 do-install-man: man
 	$(call QUIET_INSTALL, Documentation-man) \
 		$(INSTALL) -d -m 755 $(DESTDIR)$(man3dir); \
-		$(INSTALL) -m 644 $(DOC_MAN3) $(DESTDIR)$(man3dir);
+		$(INSTALL) -m 644 $(OUTPUT)*.3 $(DESTDIR)$(man3dir);
 
 install-man: check-man-tools man do-install-man
 

  reply index

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-08  9:50 Zamir SUN
2020-10-09 14:49 ` Steven Rostedt [this message]
2020-10-12 12:35   ` Zamir SUN
2020-10-12 17:58     ` Steven Rostedt

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201009104954.0fd440b5@gandalf.local.home \
    --to=rostedt@goodmis.org \
    --cc=linux-trace-devel@vger.kernel.org \
    --cc=sztsian@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Linux-Trace-Devel Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-trace-devel/0 linux-trace-devel/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-trace-devel linux-trace-devel/ https://lore.kernel.org/linux-trace-devel \
		linux-trace-devel@vger.kernel.org
	public-inbox-index linux-trace-devel

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-trace-devel


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git