From patchwork Wed Nov 9 07:54:51 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Fejfighter X-Patchwork-Id: 60256 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 34EEA3858002 for ; Wed, 9 Nov 2022 07:55:27 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 34EEA3858002 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1667980527; bh=tM0q0IYK4GCl9eNJ8tZd/HjNio7I2tsEdOgokPKQE4I=; h=Date:Subject:To:List-Id:List-Unsubscribe:List-Archive:List-Post: List-Help:List-Subscribe:From:Reply-To:From; b=RMRRa5j4N6YWm/x9U/1OcN3g14oQntNbz2XReHYKhsOkSfMnr9F+6n7RjwYTH3yzl dNvg9mCBxX+L16JhUKfPLvfvj/U2FZIzcci5nJLAaeYnsSe9uNwHkeiYJZ9U4LQngX DYLsMDuwhBIJlWN8er4d2rsBHnJQDed3DCooNHg4= X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from mail-qt1-x831.google.com (mail-qt1-x831.google.com [IPv6:2607:f8b0:4864:20::831]) by sourceware.org (Postfix) with ESMTPS id 7B27A3858D32 for ; Wed, 9 Nov 2022 07:55:03 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 7B27A3858D32 Received: by mail-qt1-x831.google.com with SMTP id a27so9958753qtw.10 for ; Tue, 08 Nov 2022 23:55:03 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=to:subject:message-id:date:from:mime-version:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=NfuuGx+4WPOh7rYwqAZuZSgUJYmi01ew6ZzIQm9OeQA=; b=1hrU4q/N/kUaKNA1tRFEbQxu9P/Vo/PxIy+NgtO7zAkdPN2uKKP+w1wmqnjSolhdT6 Ut9bZyMelvl/sTzEDttAK4R4UKUDzrFGu9o9zu3qtcBbXxjKAeO7BIVdaDlyNlexdLpq 0HZvVbK6DyDgH+wadYZ+6PZtNtMkJ1MpcYcJX4A7RnLv7hekI4lmXFKiUwkpjGa/IMPi dYajQV3zVYA1WXgCZwwIj0t8BeR8Ahu8vSJX4TQGO+/+CxRA55st8A5PM+c6wS72u3u7 9g9gAO2fyt5AdOyuyDOwI6+AyyefZGTmE8etKpgAur1Xj18bh+wfRJGc8owijfHdk4bN hNyw== X-Gm-Message-State: ANoB5plYtsli6E98BtAHmbUAlqq0aYw3JLnSqGT7T40Aeth22HywK38e Psvis20V7ahvAfsAv03FVciwseLMcgEM3l26W4St3NQFv6E= X-Google-Smtp-Source: AA0mqf5OFhRP5aaaHCDC3IM8iRfdEb9wApfZBadQmth5eXgYUjjPR6B9J+XVaYYpb5u9qcAZDfPKn6GfBHv+/Xn+iwI= X-Received: by 2002:a05:622a:11d0:b0:3a5:8ff2:8496 with SMTP id n16-20020a05622a11d000b003a58ff28496mr11169652qtk.302.1667980502656; Tue, 08 Nov 2022 23:55:02 -0800 (PST) MIME-Version: 1.0 Date: Wed, 9 Nov 2022 18:54:51 +1100 Message-ID: Subject: [PATCH] Add epub output for documentation To: gdb-patches@sourceware.org X-Spam-Status: No, score=-10.3 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, FREEMAIL_FROM, GIT_PATCH_0, HTML_MESSAGE, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-Content-Filtered-By: Mailman/MimeDel 2.1.29 X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Fejfighter via Gdb-patches From: Fejfighter Reply-To: Fejfighter Errors-To: gdb-patches-bounces+patchwork=sourceware.org@sourceware.org Sender: "Gdb-patches" Hi, Attached is a patch that uses the newly added support for producing epub in Texinfo. TESTING: I have built and viewed the epub on calibre and everything appears to work well. I have also tested building with an older version of texinfo and it does not interfere with normal docs building. FSF COPYRIGHT: I'm not sure if this is over the threshold for exemption, but I have completed paperwork for emacs and I am happy to do so again for GDB if needed Thanks, Jeff Walsh From 44fdc332ff8f41258bd6d7dd5dc520af71ca770f Mon Sep 17 00:00:00 2001 From: Jeff Walsh Date: Wed, 9 Nov 2022 16:59:43 +1100 Subject: [PATCH] Add support for epub documentation output Texinfo 7.0 added support for outputting texinfo documentation as an epub, a popular format for e-readers. Add epub targets for the manuals and relevent cleanup targets. --- gdb/doc/Makefile.in | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/gdb/doc/Makefile.in b/gdb/doc/Makefile.in index 741da0eb812..d7d03274d43 100644 --- a/gdb/doc/Makefile.in +++ b/gdb/doc/Makefile.in @@ -60,6 +60,9 @@ MAKEINFO_CMD = $(MAKEINFO) $(MAKEINFOFLAGS) $(MAKEINFO_EXTRA_FLAGS) MAKEHTML = $(MAKEINFO_CMD) --html MAKEHTMLFLAGS = +MAKEEPUB = $(MAKEINFO_CMD) --epub +MAKEEPUBFLAGS = + # where to find texi2roff, ditto TEXI2ROFF=texi2roff @@ -92,6 +95,9 @@ PDFFILES = gdb.pdf stabs.pdf refcard.pdf annotate.pdf # Files which should be generated via 'html' and installed by 'install-html' HTMLFILES = gdb/index.html stabs/index.html annotate/index.html HTMLFILES_INSTALL = gdb stabs annotate +# Files which should be generated via 'epub' and installed by 'install-epub' +EPUBFILES = gdb.epub stabs.epub annotate.epub + # There may be alternate predefined collections of switches to configure # the GDB manual. Normally this is not done in synch with the software @@ -190,6 +196,7 @@ info: $(INFO_DEPS) dvi: gdb.dvi stabs.dvi refcard.dvi annotate.dvi ps: gdb.ps stabs.ps refcard.ps annotate.ps html: $(HTMLFILES) +epub: $(EPUBFILES) pdf: $(PDFFILES) man: $(MANS) @@ -566,6 +573,10 @@ gdb.mm: $(GDB_DOC_FILES) links2roff gdb/index.html: ${GDB_DOC_FILES} $(MAKEHTML) $(MAKEHTMLFLAGS) $(READLINE_TEXI_INCFLAG) -I ${GDBMI_DIR} -I $(srcdir) $(srcdir)/gdb.texinfo +# GDB MANUAL: EPUB file +gdb.epub: ${GDB_DOC_FILES} + $(MAKEEPUB) $(MAKEEPUBFLAGS) $(READLINE_TEXI_INCFLAG) -I ${GDBMI_DIR} -I $(srcdir) $(srcdir)/gdb.texinfo + stabs.info: $(STABS_DOC_FILES) $(MAKEINFO_CMD) -I $(srcdir) -o stabs.info $(srcdir)/stabs.texinfo @@ -574,6 +585,11 @@ stabs.info: $(STABS_DOC_FILES) stabs/index.html: $(STABS_DOC_FILES) $(MAKEHTML) $(MAKEHTMLFLAGS) -I $(srcdir) $(srcdir)/stabs.texinfo +# STABS DOCUMENTATION: EPUB file + +stabs.epub: $(STABS_DOC_FILES) + $(MAKEEPUB) $(MAKEEPUBFLAGS) -I $(srcdir) $(srcdir)/stabs.texinfo + # Clean these up before each run. Avoids a catch 22 with not being # able to re-generate these files (to fix a corruption) because these # files contain a corruption. @@ -616,6 +632,9 @@ annotate.info: $(ANNOTATE_DOC_FILES) annotate/index.html: $(ANNOTATE_DOC_FILES) $(MAKEHTML) $(MAKEHTMLFLAGS) -I $(srcdir) $(srcdir)/annotate.texinfo +annotate.epub: $(ANNOTATE_DOC_FILES) + $(MAKEEPUB) $(MAKEEPUBFLAGS) -I $(srcdir) $(srcdir)/annotate.texinfo + # Man pages gdb.1: $(GDB_DOC_FILES) touch $@ @@ -679,7 +698,7 @@ distclean: clean # "clean" or "distclean". Use maintainer-clean to remove them. maintainer-clean realclean: distclean - rm -f GDBvn.texi version.subst *.info* *.dvi *.ps *.html *.pdf $(MANS) + rm -f GDBvn.texi version.subst *.info* *.dvi *.ps *.html *.pdf *.epub $(MANS) install: install-info install-man -- 2.38.1