unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
* [PATCH 1/1] devel/release-checks.sh: check PROJECT_NAME in doxygen.cfg
@ 2014-01-06  9:21 Tomi Ollila
  2014-04-06  2:02 ` build and install doxygen api docs David Bremner
  0 siblings, 1 reply; 12+ messages in thread
From: Tomi Ollila @ 2014-01-06  9:21 UTC (permalink / raw)
  To: notmuch; +Cc: tomi.ollila

Check that PROJECT_NAME configuration option in doxygen.cfg equals
"Notmuch $VERSION" in devel/release-checks.sh.
---

Note that release-checks.sh is not yet able to parse the doxygen-generated
namual pages in man/man3... Decision how to handle those is to be made
later...

 devel/release-checks.sh | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/devel/release-checks.sh b/devel/release-checks.sh
index 8938905..0585f68 100755
--- a/devel/release-checks.sh
+++ b/devel/release-checks.sh
@@ -236,6 +236,19 @@ do
 done
 echo $man_pages_ok.
 
+doxygen_notmuch_version="\"Notmuch $VERSION\""
+doxyfile=devel/doxygen.cfg
+echo -n "Checking that $doxyfile PROJECT_NAME is $doxygen_notmuch_version... "
+doxygen_project_name=`sed -n '/^PROJECT_NAME/ { s/^[^"]*//p; q;}' $doxyfile`
+if [ "$doxygen_project_name" = "$doxygen_notmuch_version" ]
+then
+	echo Yes.
+else
+	append_emsg "PROJECT_NAME '$doxygen_project_name' is not '$doxygen_notmuch_version' in '$doxyfile'"
+	echo No.
+fi
+
+
 if [ -n "$emsgs" ]
 then
 	echo
-- 
1.8.4.2

^ permalink raw reply related	[flat|nested] 12+ messages in thread

* build and install doxygen api docs
  2014-01-06  9:21 [PATCH 1/1] devel/release-checks.sh: check PROJECT_NAME in doxygen.cfg Tomi Ollila
@ 2014-04-06  2:02 ` David Bremner
  2014-04-06  2:02   ` [PATCH 1/2] doc: move doxgen config from devel/ to doc/ David Bremner
  2014-04-06  2:02   ` [PATCH 2/2] doc: build and install doxygen api docs David Bremner
  0 siblings, 2 replies; 12+ messages in thread
From: David Bremner @ 2014-04-06  2:02 UTC (permalink / raw)
  To: notmuch

I'm not sure if we really want to install the API docs yet, but I was
reviewing Tomi's patch and it occured to me that this was one more
place where we could stop hardcoding the version number.

^ permalink raw reply	[flat|nested] 12+ messages in thread

* [PATCH 1/2] doc: move doxgen config from devel/ to doc/
  2014-04-06  2:02 ` build and install doxygen api docs David Bremner
@ 2014-04-06  2:02   ` David Bremner
  2014-04-08 11:19     ` David Bremner
  2014-04-06  2:02   ` [PATCH 2/2] doc: build and install doxygen api docs David Bremner
  1 sibling, 1 reply; 12+ messages in thread
From: David Bremner @ 2014-04-06  2:02 UTC (permalink / raw)
  To: notmuch

a first step towards actually instally the API docs
---
 devel/doxygen.cfg | 304 ------------------------------------------------------
 doc/doxygen.cfg   | 304 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 304 insertions(+), 304 deletions(-)
 delete mode 100644 devel/doxygen.cfg
 create mode 100644 doc/doxygen.cfg

diff --git a/devel/doxygen.cfg b/devel/doxygen.cfg
deleted file mode 100644
index 65d5fb5..0000000
--- a/devel/doxygen.cfg
+++ /dev/null
@@ -1,304 +0,0 @@
-# Doxyfile 1.8.4
-
-#---------------------------------------------------------------------------
-# Project related configuration options
-#---------------------------------------------------------------------------
-DOXYFILE_ENCODING      = UTF-8
-PROJECT_NAME           = "Notmuch 0.17"
-PROJECT_NUMBER         =
-PROJECT_BRIEF          =
-PROJECT_LOGO           =
-OUTPUT_DIRECTORY       =
-CREATE_SUBDIRS         = NO
-OUTPUT_LANGUAGE        = English
-BRIEF_MEMBER_DESC      = YES
-REPEAT_BRIEF           = YES
-ABBREVIATE_BRIEF       =
-ALWAYS_DETAILED_SEC    = NO
-INLINE_INHERITED_MEMB  = NO
-FULL_PATH_NAMES        = NO
-STRIP_FROM_PATH        =
-STRIP_FROM_INC_PATH    =
-SHORT_NAMES            = NO
-JAVADOC_AUTOBRIEF      = YES
-QT_AUTOBRIEF           = NO
-MULTILINE_CPP_IS_BRIEF = NO
-INHERIT_DOCS           = YES
-SEPARATE_MEMBER_PAGES  = NO
-TAB_SIZE               = 8
-ALIASES                =
-TCL_SUBST              =
-OPTIMIZE_OUTPUT_FOR_C  = YES
-OPTIMIZE_OUTPUT_JAVA   = NO
-OPTIMIZE_FOR_FORTRAN   = NO
-OPTIMIZE_OUTPUT_VHDL   = NO
-EXTENSION_MAPPING      =
-MARKDOWN_SUPPORT       = YES
-AUTOLINK_SUPPORT       = YES
-BUILTIN_STL_SUPPORT    = NO
-CPP_CLI_SUPPORT        = NO
-SIP_SUPPORT            = NO
-IDL_PROPERTY_SUPPORT   = YES
-DISTRIBUTE_GROUP_DOC   = NO
-SUBGROUPING            = YES
-INLINE_GROUPED_CLASSES = NO
-INLINE_SIMPLE_STRUCTS  = NO
-TYPEDEF_HIDES_STRUCT   = YES
-LOOKUP_CACHE_SIZE      = 0
-#---------------------------------------------------------------------------
-# Build related configuration options
-#---------------------------------------------------------------------------
-EXTRACT_ALL            = NO
-EXTRACT_PRIVATE        = NO
-EXTRACT_PACKAGE        = NO
-EXTRACT_STATIC         = NO
-EXTRACT_LOCAL_CLASSES  = YES
-EXTRACT_LOCAL_METHODS  = NO
-EXTRACT_ANON_NSPACES   = NO
-HIDE_UNDOC_MEMBERS     = NO
-HIDE_UNDOC_CLASSES     = NO
-HIDE_FRIEND_COMPOUNDS  = NO
-HIDE_IN_BODY_DOCS      = NO
-INTERNAL_DOCS          = NO
-CASE_SENSE_NAMES       = YES
-HIDE_SCOPE_NAMES       = NO
-SHOW_INCLUDE_FILES     = NO
-FORCE_LOCAL_INCLUDES   = NO
-INLINE_INFO            = YES
-SORT_MEMBER_DOCS       = NO
-SORT_BRIEF_DOCS        = NO
-SORT_MEMBERS_CTORS_1ST = NO
-SORT_GROUP_NAMES       = NO
-SORT_BY_SCOPE_NAME     = NO
-STRICT_PROTO_MATCHING  = NO
-GENERATE_TODOLIST      = NO
-GENERATE_TESTLIST      = NO
-GENERATE_BUGLIST       = NO
-GENERATE_DEPRECATEDLIST= NO
-ENABLED_SECTIONS       =
-MAX_INITIALIZER_LINES  = 30
-SHOW_USED_FILES        = NO
-SHOW_FILES             = NO
-SHOW_NAMESPACES        = NO
-FILE_VERSION_FILTER    =
-LAYOUT_FILE            =
-CITE_BIB_FILES         =
-#---------------------------------------------------------------------------
-# configuration options related to warning and progress messages
-#---------------------------------------------------------------------------
-QUIET                  = YES
-WARNINGS               = YES
-WARN_IF_UNDOCUMENTED   = YES
-WARN_IF_DOC_ERROR      = YES
-WARN_NO_PARAMDOC       = NO
-WARN_FORMAT            = "$file:$line: $text"
-WARN_LOGFILE           =
-#---------------------------------------------------------------------------
-# configuration options related to the input files
-#---------------------------------------------------------------------------
-INPUT                  = lib/notmuch.h
-INPUT_ENCODING         = UTF-8
-FILE_PATTERNS          =
-RECURSIVE              = NO
-EXCLUDE                =
-EXCLUDE_SYMLINKS       = NO
-EXCLUDE_PATTERNS       =
-EXCLUDE_SYMBOLS        =
-EXAMPLE_PATH           =
-EXAMPLE_PATTERNS       =
-EXAMPLE_RECURSIVE      = NO
-IMAGE_PATH             =
-INPUT_FILTER           =
-FILTER_PATTERNS        =
-FILTER_SOURCE_FILES    = NO
-FILTER_SOURCE_PATTERNS =
-USE_MDFILE_AS_MAINPAGE =
-#---------------------------------------------------------------------------
-# configuration options related to source browsing
-#---------------------------------------------------------------------------
-SOURCE_BROWSER         = NO
-INLINE_SOURCES         = NO
-STRIP_CODE_COMMENTS    = YES
-REFERENCED_BY_RELATION = NO
-REFERENCES_RELATION    = NO
-REFERENCES_LINK_SOURCE = YES
-USE_HTAGS              = NO
-VERBATIM_HEADERS       = NO
-#---------------------------------------------------------------------------
-# configuration options related to the alphabetical class index
-#---------------------------------------------------------------------------
-ALPHABETICAL_INDEX     = NO
-COLS_IN_ALPHA_INDEX    = 5
-IGNORE_PREFIX          =
-#---------------------------------------------------------------------------
-# configuration options related to the HTML output
-#---------------------------------------------------------------------------
-GENERATE_HTML          = NO
-HTML_OUTPUT            = html
-HTML_FILE_EXTENSION    = .html
-HTML_HEADER            =
-HTML_FOOTER            =
-HTML_STYLESHEET        =
-HTML_EXTRA_STYLESHEET  =
-HTML_EXTRA_FILES       =
-HTML_COLORSTYLE_HUE    = 220
-HTML_COLORSTYLE_SAT    = 100
-HTML_COLORSTYLE_GAMMA  = 80
-HTML_TIMESTAMP         = YES
-HTML_DYNAMIC_SECTIONS  = NO
-HTML_INDEX_NUM_ENTRIES = 100
-GENERATE_DOCSET        = NO
-DOCSET_FEEDNAME        = "Doxygen generated docs"
-DOCSET_BUNDLE_ID       = org.doxygen.Project
-DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
-DOCSET_PUBLISHER_NAME  = Publisher
-GENERATE_HTMLHELP      = NO
-CHM_FILE               =
-HHC_LOCATION           =
-GENERATE_CHI           = NO
-CHM_INDEX_ENCODING     =
-BINARY_TOC             = NO
-TOC_EXPAND             = NO
-GENERATE_QHP           = NO
-QCH_FILE               =
-QHP_NAMESPACE          = org.doxygen.Project
-QHP_VIRTUAL_FOLDER     = doc
-QHP_CUST_FILTER_NAME   =
-QHP_CUST_FILTER_ATTRS  =
-QHP_SECT_FILTER_ATTRS  =
-QHG_LOCATION           =
-GENERATE_ECLIPSEHELP   = NO
-ECLIPSE_DOC_ID         = org.doxygen.Project
-DISABLE_INDEX          = NO
-GENERATE_TREEVIEW      = NO
-ENUM_VALUES_PER_LINE   = 4
-TREEVIEW_WIDTH         = 250
-EXT_LINKS_IN_WINDOW    = NO
-FORMULA_FONTSIZE       = 10
-FORMULA_TRANSPARENT    = YES
-USE_MATHJAX            = NO
-MATHJAX_FORMAT         = HTML-CSS
-MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
-MATHJAX_EXTENSIONS     =
-MATHJAX_CODEFILE       =
-SEARCHENGINE           = YES
-SERVER_BASED_SEARCH    = NO
-EXTERNAL_SEARCH        = NO
-SEARCHENGINE_URL       =
-SEARCHDATA_FILE        = searchdata.xml
-EXTERNAL_SEARCH_ID     =
-EXTRA_SEARCH_MAPPINGS  =
-#---------------------------------------------------------------------------
-# configuration options related to the LaTeX output
-#---------------------------------------------------------------------------
-GENERATE_LATEX         = NO
-LATEX_OUTPUT           = latex
-LATEX_CMD_NAME         = latex
-MAKEINDEX_CMD_NAME     = makeindex
-COMPACT_LATEX          = NO
-PAPER_TYPE             = a4
-EXTRA_PACKAGES         =
-LATEX_HEADER           =
-LATEX_FOOTER           =
-LATEX_EXTRA_FILES      =
-PDF_HYPERLINKS         = YES
-USE_PDFLATEX           = YES
-LATEX_BATCHMODE        = NO
-LATEX_HIDE_INDICES     = NO
-LATEX_SOURCE_CODE      = NO
-LATEX_BIB_STYLE        = plain
-#---------------------------------------------------------------------------
-# configuration options related to the RTF output
-#---------------------------------------------------------------------------
-GENERATE_RTF           = NO
-RTF_OUTPUT             = rtf
-COMPACT_RTF            = NO
-RTF_HYPERLINKS         = NO
-RTF_STYLESHEET_FILE    =
-RTF_EXTENSIONS_FILE    =
-#---------------------------------------------------------------------------
-# configuration options related to the man page output
-#---------------------------------------------------------------------------
-GENERATE_MAN           = YES
-MAN_OUTPUT             = man
-MAN_EXTENSION          = .3
-MAN_LINKS              = NO
-#---------------------------------------------------------------------------
-# configuration options related to the XML output
-#---------------------------------------------------------------------------
-GENERATE_XML           = NO
-XML_OUTPUT             = xml
-XML_SCHEMA             =
-XML_DTD                =
-XML_PROGRAMLISTING     = YES
-#---------------------------------------------------------------------------
-# configuration options related to the DOCBOOK output
-#---------------------------------------------------------------------------
-GENERATE_DOCBOOK       = NO
-DOCBOOK_OUTPUT         = docbook
-#---------------------------------------------------------------------------
-# configuration options for the AutoGen Definitions output
-#---------------------------------------------------------------------------
-GENERATE_AUTOGEN_DEF   = NO
-#---------------------------------------------------------------------------
-# configuration options related to the Perl module output
-#---------------------------------------------------------------------------
-GENERATE_PERLMOD       = NO
-PERLMOD_LATEX          = NO
-PERLMOD_PRETTY         = YES
-PERLMOD_MAKEVAR_PREFIX =
-#---------------------------------------------------------------------------
-# Configuration options related to the preprocessor
-#---------------------------------------------------------------------------
-ENABLE_PREPROCESSING   = YES
-MACRO_EXPANSION        = NO
-EXPAND_ONLY_PREDEF     = NO
-SEARCH_INCLUDES        = NO
-INCLUDE_PATH           =
-INCLUDE_FILE_PATTERNS  =
-PREDEFINED             = __DOXYGEN__
-EXPAND_AS_DEFINED      =
-SKIP_FUNCTION_MACROS   = YES
-#---------------------------------------------------------------------------
-# Configuration::additions related to external references
-#---------------------------------------------------------------------------
-TAGFILES               =
-GENERATE_TAGFILE       =
-ALLEXTERNALS           = NO
-EXTERNAL_GROUPS        = NO
-EXTERNAL_PAGES         = NO
-PERL_PATH              = /usr/bin/perl
-#---------------------------------------------------------------------------
-# Configuration options related to the dot tool
-#---------------------------------------------------------------------------
-CLASS_DIAGRAMS         = NO
-MSCGEN_PATH            =
-HIDE_UNDOC_RELATIONS   = YES
-HAVE_DOT               = NO
-DOT_NUM_THREADS        = 0
-DOT_FONTNAME           = Helvetica
-DOT_FONTSIZE           = 10
-DOT_FONTPATH           =
-CLASS_GRAPH            = YES
-COLLABORATION_GRAPH    = YES
-GROUP_GRAPHS           = YES
-UML_LOOK               = NO
-UML_LIMIT_NUM_FIELDS   = 10
-TEMPLATE_RELATIONS     = NO
-INCLUDE_GRAPH          = NO
-INCLUDED_BY_GRAPH      = NO
-CALL_GRAPH             = NO
-CALLER_GRAPH           = NO
-GRAPHICAL_HIERARCHY    = NO
-DIRECTORY_GRAPH        = NO
-DOT_IMAGE_FORMAT       = png
-INTERACTIVE_SVG        = NO
-DOT_PATH               =
-DOTFILE_DIRS           =
-MSCFILE_DIRS           =
-DOT_GRAPH_MAX_NODES    = 50
-MAX_DOT_GRAPH_DEPTH    = 0
-DOT_TRANSPARENT        = NO
-DOT_MULTI_TARGETS      = YES
-GENERATE_LEGEND        = NO
-DOT_CLEANUP            = YES
diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg
new file mode 100644
index 0000000..65d5fb5
--- /dev/null
+++ b/doc/doxygen.cfg
@@ -0,0 +1,304 @@
+# Doxyfile 1.8.4
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+DOXYFILE_ENCODING      = UTF-8
+PROJECT_NAME           = "Notmuch 0.17"
+PROJECT_NUMBER         =
+PROJECT_BRIEF          =
+PROJECT_LOGO           =
+OUTPUT_DIRECTORY       =
+CREATE_SUBDIRS         = NO
+OUTPUT_LANGUAGE        = English
+BRIEF_MEMBER_DESC      = YES
+REPEAT_BRIEF           = YES
+ABBREVIATE_BRIEF       =
+ALWAYS_DETAILED_SEC    = NO
+INLINE_INHERITED_MEMB  = NO
+FULL_PATH_NAMES        = NO
+STRIP_FROM_PATH        =
+STRIP_FROM_INC_PATH    =
+SHORT_NAMES            = NO
+JAVADOC_AUTOBRIEF      = YES
+QT_AUTOBRIEF           = NO
+MULTILINE_CPP_IS_BRIEF = NO
+INHERIT_DOCS           = YES
+SEPARATE_MEMBER_PAGES  = NO
+TAB_SIZE               = 8
+ALIASES                =
+TCL_SUBST              =
+OPTIMIZE_OUTPUT_FOR_C  = YES
+OPTIMIZE_OUTPUT_JAVA   = NO
+OPTIMIZE_FOR_FORTRAN   = NO
+OPTIMIZE_OUTPUT_VHDL   = NO
+EXTENSION_MAPPING      =
+MARKDOWN_SUPPORT       = YES
+AUTOLINK_SUPPORT       = YES
+BUILTIN_STL_SUPPORT    = NO
+CPP_CLI_SUPPORT        = NO
+SIP_SUPPORT            = NO
+IDL_PROPERTY_SUPPORT   = YES
+DISTRIBUTE_GROUP_DOC   = NO
+SUBGROUPING            = YES
+INLINE_GROUPED_CLASSES = NO
+INLINE_SIMPLE_STRUCTS  = NO
+TYPEDEF_HIDES_STRUCT   = YES
+LOOKUP_CACHE_SIZE      = 0
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+EXTRACT_ALL            = NO
+EXTRACT_PRIVATE        = NO
+EXTRACT_PACKAGE        = NO
+EXTRACT_STATIC         = NO
+EXTRACT_LOCAL_CLASSES  = YES
+EXTRACT_LOCAL_METHODS  = NO
+EXTRACT_ANON_NSPACES   = NO
+HIDE_UNDOC_MEMBERS     = NO
+HIDE_UNDOC_CLASSES     = NO
+HIDE_FRIEND_COMPOUNDS  = NO
+HIDE_IN_BODY_DOCS      = NO
+INTERNAL_DOCS          = NO
+CASE_SENSE_NAMES       = YES
+HIDE_SCOPE_NAMES       = NO
+SHOW_INCLUDE_FILES     = NO
+FORCE_LOCAL_INCLUDES   = NO
+INLINE_INFO            = YES
+SORT_MEMBER_DOCS       = NO
+SORT_BRIEF_DOCS        = NO
+SORT_MEMBERS_CTORS_1ST = NO
+SORT_GROUP_NAMES       = NO
+SORT_BY_SCOPE_NAME     = NO
+STRICT_PROTO_MATCHING  = NO
+GENERATE_TODOLIST      = NO
+GENERATE_TESTLIST      = NO
+GENERATE_BUGLIST       = NO
+GENERATE_DEPRECATEDLIST= NO
+ENABLED_SECTIONS       =
+MAX_INITIALIZER_LINES  = 30
+SHOW_USED_FILES        = NO
+SHOW_FILES             = NO
+SHOW_NAMESPACES        = NO
+FILE_VERSION_FILTER    =
+LAYOUT_FILE            =
+CITE_BIB_FILES         =
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET                  = YES
+WARNINGS               = YES
+WARN_IF_UNDOCUMENTED   = YES
+WARN_IF_DOC_ERROR      = YES
+WARN_NO_PARAMDOC       = NO
+WARN_FORMAT            = "$file:$line: $text"
+WARN_LOGFILE           =
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT                  = lib/notmuch.h
+INPUT_ENCODING         = UTF-8
+FILE_PATTERNS          =
+RECURSIVE              = NO
+EXCLUDE                =
+EXCLUDE_SYMLINKS       = NO
+EXCLUDE_PATTERNS       =
+EXCLUDE_SYMBOLS        =
+EXAMPLE_PATH           =
+EXAMPLE_PATTERNS       =
+EXAMPLE_RECURSIVE      = NO
+IMAGE_PATH             =
+INPUT_FILTER           =
+FILTER_PATTERNS        =
+FILTER_SOURCE_FILES    = NO
+FILTER_SOURCE_PATTERNS =
+USE_MDFILE_AS_MAINPAGE =
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER         = NO
+INLINE_SOURCES         = NO
+STRIP_CODE_COMMENTS    = YES
+REFERENCED_BY_RELATION = NO
+REFERENCES_RELATION    = NO
+REFERENCES_LINK_SOURCE = YES
+USE_HTAGS              = NO
+VERBATIM_HEADERS       = NO
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX     = NO
+COLS_IN_ALPHA_INDEX    = 5
+IGNORE_PREFIX          =
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML          = NO
+HTML_OUTPUT            = html
+HTML_FILE_EXTENSION    = .html
+HTML_HEADER            =
+HTML_FOOTER            =
+HTML_STYLESHEET        =
+HTML_EXTRA_STYLESHEET  =
+HTML_EXTRA_FILES       =
+HTML_COLORSTYLE_HUE    = 220
+HTML_COLORSTYLE_SAT    = 100
+HTML_COLORSTYLE_GAMMA  = 80
+HTML_TIMESTAMP         = YES
+HTML_DYNAMIC_SECTIONS  = NO
+HTML_INDEX_NUM_ENTRIES = 100
+GENERATE_DOCSET        = NO
+DOCSET_FEEDNAME        = "Doxygen generated docs"
+DOCSET_BUNDLE_ID       = org.doxygen.Project
+DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
+DOCSET_PUBLISHER_NAME  = Publisher
+GENERATE_HTMLHELP      = NO
+CHM_FILE               =
+HHC_LOCATION           =
+GENERATE_CHI           = NO
+CHM_INDEX_ENCODING     =
+BINARY_TOC             = NO
+TOC_EXPAND             = NO
+GENERATE_QHP           = NO
+QCH_FILE               =
+QHP_NAMESPACE          = org.doxygen.Project
+QHP_VIRTUAL_FOLDER     = doc
+QHP_CUST_FILTER_NAME   =
+QHP_CUST_FILTER_ATTRS  =
+QHP_SECT_FILTER_ATTRS  =
+QHG_LOCATION           =
+GENERATE_ECLIPSEHELP   = NO
+ECLIPSE_DOC_ID         = org.doxygen.Project
+DISABLE_INDEX          = NO
+GENERATE_TREEVIEW      = NO
+ENUM_VALUES_PER_LINE   = 4
+TREEVIEW_WIDTH         = 250
+EXT_LINKS_IN_WINDOW    = NO
+FORMULA_FONTSIZE       = 10
+FORMULA_TRANSPARENT    = YES
+USE_MATHJAX            = NO
+MATHJAX_FORMAT         = HTML-CSS
+MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
+MATHJAX_EXTENSIONS     =
+MATHJAX_CODEFILE       =
+SEARCHENGINE           = YES
+SERVER_BASED_SEARCH    = NO
+EXTERNAL_SEARCH        = NO
+SEARCHENGINE_URL       =
+SEARCHDATA_FILE        = searchdata.xml
+EXTERNAL_SEARCH_ID     =
+EXTRA_SEARCH_MAPPINGS  =
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX         = NO
+LATEX_OUTPUT           = latex
+LATEX_CMD_NAME         = latex
+MAKEINDEX_CMD_NAME     = makeindex
+COMPACT_LATEX          = NO
+PAPER_TYPE             = a4
+EXTRA_PACKAGES         =
+LATEX_HEADER           =
+LATEX_FOOTER           =
+LATEX_EXTRA_FILES      =
+PDF_HYPERLINKS         = YES
+USE_PDFLATEX           = YES
+LATEX_BATCHMODE        = NO
+LATEX_HIDE_INDICES     = NO
+LATEX_SOURCE_CODE      = NO
+LATEX_BIB_STYLE        = plain
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF           = NO
+RTF_OUTPUT             = rtf
+COMPACT_RTF            = NO
+RTF_HYPERLINKS         = NO
+RTF_STYLESHEET_FILE    =
+RTF_EXTENSIONS_FILE    =
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+GENERATE_MAN           = YES
+MAN_OUTPUT             = man
+MAN_EXTENSION          = .3
+MAN_LINKS              = NO
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+GENERATE_XML           = NO
+XML_OUTPUT             = xml
+XML_SCHEMA             =
+XML_DTD                =
+XML_PROGRAMLISTING     = YES
+#---------------------------------------------------------------------------
+# configuration options related to the DOCBOOK output
+#---------------------------------------------------------------------------
+GENERATE_DOCBOOK       = NO
+DOCBOOK_OUTPUT         = docbook
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+GENERATE_AUTOGEN_DEF   = NO
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+GENERATE_PERLMOD       = NO
+PERLMOD_LATEX          = NO
+PERLMOD_PRETTY         = YES
+PERLMOD_MAKEVAR_PREFIX =
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING   = YES
+MACRO_EXPANSION        = NO
+EXPAND_ONLY_PREDEF     = NO
+SEARCH_INCLUDES        = NO
+INCLUDE_PATH           =
+INCLUDE_FILE_PATTERNS  =
+PREDEFINED             = __DOXYGEN__
+EXPAND_AS_DEFINED      =
+SKIP_FUNCTION_MACROS   = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+TAGFILES               =
+GENERATE_TAGFILE       =
+ALLEXTERNALS           = NO
+EXTERNAL_GROUPS        = NO
+EXTERNAL_PAGES         = NO
+PERL_PATH              = /usr/bin/perl
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS         = NO
+MSCGEN_PATH            =
+HIDE_UNDOC_RELATIONS   = YES
+HAVE_DOT               = NO
+DOT_NUM_THREADS        = 0
+DOT_FONTNAME           = Helvetica
+DOT_FONTSIZE           = 10
+DOT_FONTPATH           =
+CLASS_GRAPH            = YES
+COLLABORATION_GRAPH    = YES
+GROUP_GRAPHS           = YES
+UML_LOOK               = NO
+UML_LIMIT_NUM_FIELDS   = 10
+TEMPLATE_RELATIONS     = NO
+INCLUDE_GRAPH          = NO
+INCLUDED_BY_GRAPH      = NO
+CALL_GRAPH             = NO
+CALLER_GRAPH           = NO
+GRAPHICAL_HIERARCHY    = NO
+DIRECTORY_GRAPH        = NO
+DOT_IMAGE_FORMAT       = png
+INTERACTIVE_SVG        = NO
+DOT_PATH               =
+DOTFILE_DIRS           =
+MSCFILE_DIRS           =
+DOT_GRAPH_MAX_NODES    = 50
+MAX_DOT_GRAPH_DEPTH    = 0
+DOT_TRANSPARENT        = NO
+DOT_MULTI_TARGETS      = YES
+GENERATE_LEGEND        = NO
+DOT_CLEANUP            = YES
-- 
1.9.0

^ permalink raw reply related	[flat|nested] 12+ messages in thread

* [PATCH 2/2] doc: build and install doxygen api docs
  2014-04-06  2:02 ` build and install doxygen api docs David Bremner
  2014-04-06  2:02   ` [PATCH 1/2] doc: move doxgen config from devel/ to doc/ David Bremner
@ 2014-04-06  2:02   ` David Bremner
  2014-04-06  7:57     ` Tomi Ollila
  2014-07-01 16:40     ` David Bremner
  1 sibling, 2 replies; 12+ messages in thread
From: David Bremner @ 2014-04-06  2:02 UTC (permalink / raw)
  To: notmuch

Add to the build-man and install-man targets. We also stop hardcoding
the version information into doxygen.cfg
---
 doc/Makefile.local | 14 ++++++++++++--
 doc/doxygen.cfg    |  4 ++--
 2 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/doc/Makefile.local b/doc/Makefile.local
index 0980c71..5189f97 100644
--- a/doc/Makefile.local
+++ b/doc/Makefile.local
@@ -12,6 +12,8 @@ mkdocdeps := python $(srcdir)/$(dir)/mkdocdeps.py
 
 # Internal variables.
 ALLSPHINXOPTS   := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(srcdir)/$(dir)
+APIMAN		:= $(DOCBUILDDIR)/man/man3/notmuch.3
+DOXYFILE	:= $(dir)/doxygen.cfg
 
 .PHONY: sphinx-html sphinx-texinfo sphinx-info
 
@@ -31,7 +33,7 @@ sphinx-info: sphinx-texinfo
 
 -include $(dir)/docdeps.mk
 
-MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES})
+MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES} ${APIMAN})
 
 # Use the man page converter that is available. We should never depend
 # on MAN_ROFF_FILES if a converter is not available.
@@ -59,16 +61,24 @@ else
 build-man: ${MAN_GZIP_FILES}
 install-man: ${MAN_GZIP_FILES}
 	mkdir -p "$(DESTDIR)$(mandir)/man1"
+	mkdir -p "$(DESTDIR)$(mandir)/man3"
 	mkdir -p "$(DESTDIR)$(mandir)/man5"
 	mkdir -p "$(DESTDIR)$(mandir)/man7"
 	install -m0644 $(DOCBUILDDIR)/man/man1/*.1.gz $(DESTDIR)/$(mandir)/man1
+	install -m0644 $(DOCBUILDDIR)/man/man3/*.3.gz $(DESTDIR)/$(mandir)/man3
 	install -m0644 $(DOCBUILDDIR)/man/man5/*.5.gz $(DESTDIR)/$(mandir)/man5
 	install -m0644 $(DOCBUILDDIR)/man/man7/*.7.gz $(DESTDIR)/$(mandir)/man7
 	cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch.1.gz notmuch-setup.1.gz
 endif
 
+$(APIMAN): $(dir)/version.dox $(dir)/doxygen.cfg $(srcdir)/lib/notmuch.h
+	doxygen $(DOXYFILE)
+
+$(dir)/version.dox: $(srcdir)/version
+	sed -e 's/^/PROJECT_NAME = \"Notmuch /' -e 's/$$/\"/' < $< > $@
+
 $(dir)/docdeps.mk: $(dir)/conf.py $(dir)/mkdocdeps.py
 	$(mkdocdeps) $(srcdir)/doc $(DOCBUILDDIR) $@
 
 CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk $(dir)/man.stamp
-CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES)
+CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/version.dox
diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg
index 65d5fb5..bf9f075 100644
--- a/doc/doxygen.cfg
+++ b/doc/doxygen.cfg
@@ -4,11 +4,11 @@
 # Project related configuration options
 #---------------------------------------------------------------------------
 DOXYFILE_ENCODING      = UTF-8
-PROJECT_NAME           = "Notmuch 0.17"
+@INCLUDE	       =  "doc/version.dox"
 PROJECT_NUMBER         =
 PROJECT_BRIEF          =
 PROJECT_LOGO           =
-OUTPUT_DIRECTORY       =
+OUTPUT_DIRECTORY       = doc/_build
 CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English
 BRIEF_MEMBER_DESC      = YES
-- 
1.9.0

^ permalink raw reply related	[flat|nested] 12+ messages in thread

* Re: [PATCH 2/2] doc: build and install doxygen api docs
  2014-04-06  2:02   ` [PATCH 2/2] doc: build and install doxygen api docs David Bremner
@ 2014-04-06  7:57     ` Tomi Ollila
  2014-07-01 16:40     ` David Bremner
  1 sibling, 0 replies; 12+ messages in thread
From: Tomi Ollila @ 2014-04-06  7:57 UTC (permalink / raw)
  To: David Bremner, notmuch

On Sun, Apr 06 2014, David Bremner <david@tethera.net> wrote:

> Add to the build-man and install-man targets. We also stop hardcoding
> the version information into doxygen.cfg
> ---
>  doc/Makefile.local | 14 ++++++++++++--
>  doc/doxygen.cfg    |  4 ++--
>  2 files changed, 14 insertions(+), 4 deletions(-)
>
> diff --git a/doc/Makefile.local b/doc/Makefile.local
> index 0980c71..5189f97 100644
> --- a/doc/Makefile.local
> +++ b/doc/Makefile.local
> @@ -12,6 +12,8 @@ mkdocdeps := python $(srcdir)/$(dir)/mkdocdeps.py
>  
>  # Internal variables.
>  ALLSPHINXOPTS   := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(srcdir)/$(dir)
> +APIMAN		:= $(DOCBUILDDIR)/man/man3/notmuch.3
> +DOXYFILE	:= $(dir)/doxygen.cfg
>  
>  .PHONY: sphinx-html sphinx-texinfo sphinx-info
>  
> @@ -31,7 +33,7 @@ sphinx-info: sphinx-texinfo
>  
>  -include $(dir)/docdeps.mk
>  
> -MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES})
> +MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES} ${APIMAN})
>  
>  # Use the man page converter that is available. We should never depend
>  # on MAN_ROFF_FILES if a converter is not available.
> @@ -59,16 +61,24 @@ else
>  build-man: ${MAN_GZIP_FILES}
>  install-man: ${MAN_GZIP_FILES}
>  	mkdir -p "$(DESTDIR)$(mandir)/man1"
> +	mkdir -p "$(DESTDIR)$(mandir)/man3"
>  	mkdir -p "$(DESTDIR)$(mandir)/man5"
>  	mkdir -p "$(DESTDIR)$(mandir)/man7"
>  	install -m0644 $(DOCBUILDDIR)/man/man1/*.1.gz $(DESTDIR)/$(mandir)/man1
> +	install -m0644 $(DOCBUILDDIR)/man/man3/*.3.gz $(DESTDIR)/$(mandir)/man3
>  	install -m0644 $(DOCBUILDDIR)/man/man5/*.5.gz $(DESTDIR)/$(mandir)/man5
>  	install -m0644 $(DOCBUILDDIR)/man/man7/*.7.gz $(DESTDIR)/$(mandir)/man7
>  	cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch.1.gz notmuch-setup.1.gz
>  endif
>  
> +$(APIMAN): $(dir)/version.dox $(dir)/doxygen.cfg $(srcdir)/lib/notmuch.h
> +	doxygen $(DOXYFILE)
> +
> +$(dir)/version.dox: $(srcdir)/version
> +	sed -e 's/^/PROJECT_NAME = \"Notmuch /' -e 's/$$/\"/' < $< > $@
> +

LGTM, although:

      echo "PROJECT_NAME = \"Notmuch `cat $<`\"" >$@

no, 

      echo 'PROJECT_NAME = "Notmuch $(VERSION)"' > $@


... and, the dependency should be to version.stamp (w/o $(srcdir)) after

id:1395261431-24668-1b-git-send-email-tomi.ollila@iki.fi is merged :D

... as especially developers need to know the exact version they have
in their git tree instead of last released one.

I marked my patch in this thread obsolete (my previous statement makes this
obvious) and 1/1 on this series ready.

Tomi



>  $(dir)/docdeps.mk: $(dir)/conf.py $(dir)/mkdocdeps.py
>  	$(mkdocdeps) $(srcdir)/doc $(DOCBUILDDIR) $@
>  
>  CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk $(dir)/man.stamp
> -CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES)
> +CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/version.dox
> diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg
> index 65d5fb5..bf9f075 100644
> --- a/doc/doxygen.cfg
> +++ b/doc/doxygen.cfg
> @@ -4,11 +4,11 @@
>  # Project related configuration options
>  #---------------------------------------------------------------------------
>  DOXYFILE_ENCODING      = UTF-8
> -PROJECT_NAME           = "Notmuch 0.17"
> +@INCLUDE	       =  "doc/version.dox"
>  PROJECT_NUMBER         =
>  PROJECT_BRIEF          =
>  PROJECT_LOGO           =
> -OUTPUT_DIRECTORY       =
> +OUTPUT_DIRECTORY       = doc/_build
>  CREATE_SUBDIRS         = NO
>  OUTPUT_LANGUAGE        = English
>  BRIEF_MEMBER_DESC      = YES
> -- 
> 1.9.0

^ permalink raw reply	[flat|nested] 12+ messages in thread

* Re: [PATCH 1/2] doc: move doxgen config from devel/ to doc/
  2014-04-06  2:02   ` [PATCH 1/2] doc: move doxgen config from devel/ to doc/ David Bremner
@ 2014-04-08 11:19     ` David Bremner
  0 siblings, 0 replies; 12+ messages in thread
From: David Bremner @ 2014-04-08 11:19 UTC (permalink / raw)
  To: notmuch

David Bremner <david@tethera.net> writes:

> a first step towards actually instally the API docs

pushed this one patch, typo and all :(.

d

^ permalink raw reply	[flat|nested] 12+ messages in thread

* (no subject)
  2014-04-06  2:02   ` [PATCH 2/2] doc: build and install doxygen api docs David Bremner
  2014-04-06  7:57     ` Tomi Ollila
@ 2014-07-01 16:40     ` David Bremner
  2014-07-01 16:40       ` [PATCH 1/2] doc: build and install doxygen api docs David Bremner
  2014-07-01 16:40       ` [PATCH 2/2] doc: postprocess notmuch.3 David Bremner
  1 sibling, 2 replies; 12+ messages in thread
From: David Bremner @ 2014-07-01 16:40 UTC (permalink / raw)
  To: notmuch

- revise version hackery per Tomi's suggestion
- add hack to clean up doxygen's terrible nroff.

Obviously the latter is somewhat fragile, but it should fail gently,
i.e. do nothing, if the doxygen output is fixed upstream.

^ permalink raw reply	[flat|nested] 12+ messages in thread

* [PATCH 1/2] doc: build and install doxygen api docs
  2014-07-01 16:40     ` David Bremner
@ 2014-07-01 16:40       ` David Bremner
  2014-07-04 11:56         ` David Bremner
  2014-07-01 16:40       ` [PATCH 2/2] doc: postprocess notmuch.3 David Bremner
  1 sibling, 1 reply; 12+ messages in thread
From: David Bremner @ 2014-07-01 16:40 UTC (permalink / raw)
  To: notmuch

Add to the build-man and install-man targets. We also stop hardcoding
the version information into doxygen.cfg
---
 doc/Makefile.local | 14 ++++++++++++--
 doc/doxygen.cfg    |  4 ++--
 2 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/doc/Makefile.local b/doc/Makefile.local
index bbd4610..e9402b4 100644
--- a/doc/Makefile.local
+++ b/doc/Makefile.local
@@ -12,6 +12,8 @@ mkdocdeps := python $(srcdir)/$(dir)/mkdocdeps.py
 
 # Internal variables.
 ALLSPHINXOPTS   := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(srcdir)/$(dir)
+APIMAN		:= $(DOCBUILDDIR)/man/man3/notmuch.3
+DOXYFILE	:= $(dir)/doxygen.cfg
 
 .PHONY: sphinx-html sphinx-texinfo sphinx-info
 
@@ -31,7 +33,7 @@ sphinx-info: sphinx-texinfo
 
 -include $(dir)/docdeps.mk
 
-MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES})
+MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES} ${APIMAN})
 
 # Use the man page converter that is available. We should never depend
 # on MAN_ROFF_FILES if a converter is not available.
@@ -66,16 +68,24 @@ else
 build-man: ${MAN_GZIP_FILES}
 install-man: ${MAN_GZIP_FILES}
 	mkdir -p "$(DESTDIR)$(mandir)/man1"
+	mkdir -p "$(DESTDIR)$(mandir)/man3"
 	mkdir -p "$(DESTDIR)$(mandir)/man5"
 	mkdir -p "$(DESTDIR)$(mandir)/man7"
 	install -m0644 $(DOCBUILDDIR)/man/man1/*.1.gz $(DESTDIR)/$(mandir)/man1
+	install -m0644 $(DOCBUILDDIR)/man/man3/*.3.gz $(DESTDIR)/$(mandir)/man3
 	install -m0644 $(DOCBUILDDIR)/man/man5/*.5.gz $(DESTDIR)/$(mandir)/man5
 	install -m0644 $(DOCBUILDDIR)/man/man7/*.7.gz $(DESTDIR)/$(mandir)/man7
 	cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch.1.gz notmuch-setup.1.gz
 endif
 
+$(APIMAN): $(dir)/version.dox $(dir)/doxygen.cfg $(srcdir)/lib/notmuch.h
+	doxygen $(DOXYFILE)
+
+$(dir)/version.dox: version.stamp
+	echo "PROJECT_NAME = \"Notmuch $(VERSION)\"" > $@
+
 $(dir)/docdeps.mk: $(dir)/conf.py $(dir)/mkdocdeps.py
 	$(mkdocdeps) $(srcdir)/doc $(DOCBUILDDIR) $@
 
 CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk $(DOCBUILDDIR)/.roff.stamp
-CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/conf.pyc
+CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/conf.pyc $(dir)/version.dox
diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg
index bfbfcab..bf9f075 100644
--- a/doc/doxygen.cfg
+++ b/doc/doxygen.cfg
@@ -4,11 +4,11 @@
 # Project related configuration options
 #---------------------------------------------------------------------------
 DOXYFILE_ENCODING      = UTF-8
-PROJECT_NAME           = "Notmuch 0.18"
+@INCLUDE	       =  "doc/version.dox"
 PROJECT_NUMBER         =
 PROJECT_BRIEF          =
 PROJECT_LOGO           =
-OUTPUT_DIRECTORY       =
+OUTPUT_DIRECTORY       = doc/_build
 CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English
 BRIEF_MEMBER_DESC      = YES
-- 
2.0.0.rc2

^ permalink raw reply related	[flat|nested] 12+ messages in thread

* [PATCH 2/2] doc: postprocess notmuch.3
  2014-07-01 16:40     ` David Bremner
  2014-07-01 16:40       ` [PATCH 1/2] doc: build and install doxygen api docs David Bremner
@ 2014-07-01 16:40       ` David Bremner
  2014-07-01 18:46         ` Tomi Ollila
  1 sibling, 1 reply; 12+ messages in thread
From: David Bremner @ 2014-07-01 16:40 UTC (permalink / raw)
  To: notmuch

Remove excess italics from doxygen output. It seems to make no
sense (and is certainly ugly) to italicize the first argument to the
.RI macro.
---
 doc/Makefile.local | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/doc/Makefile.local b/doc/Makefile.local
index e9402b4..0114b24 100644
--- a/doc/Makefile.local
+++ b/doc/Makefile.local
@@ -80,6 +80,8 @@ endif
 
 $(APIMAN): $(dir)/version.dox $(dir)/doxygen.cfg $(srcdir)/lib/notmuch.h
 	doxygen $(DOXYFILE)
+	sed -i 's/^[.]RI "[\]fI/.RI "\\fP/' $(dir)/doc/_build/man/man3/notmuch.3 
+
 
 $(dir)/version.dox: version.stamp
 	echo "PROJECT_NAME = \"Notmuch $(VERSION)\"" > $@
-- 
2.0.0.rc2

^ permalink raw reply related	[flat|nested] 12+ messages in thread

* Re: [PATCH 2/2] doc: postprocess notmuch.3
  2014-07-01 16:40       ` [PATCH 2/2] doc: postprocess notmuch.3 David Bremner
@ 2014-07-01 18:46         ` Tomi Ollila
  2014-07-01 19:13           ` [Patch v2] " David Bremner
  0 siblings, 1 reply; 12+ messages in thread
From: Tomi Ollila @ 2014-07-01 18:46 UTC (permalink / raw)
  To: David Bremner, notmuch

On Tue, Jul 01 2014, David Bremner <david@tethera.net> wrote:

> Remove excess italics from doxygen output. It seems to make no
> sense (and is certainly ugly) to italicize the first argument to the
> .RI macro.
> ---
>  doc/Makefile.local | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/doc/Makefile.local b/doc/Makefile.local
> index e9402b4..0114b24 100644
> --- a/doc/Makefile.local
> +++ b/doc/Makefile.local
> @@ -80,6 +80,8 @@ endif
>  
>  $(APIMAN): $(dir)/version.dox $(dir)/doxygen.cfg $(srcdir)/lib/notmuch.h
>  	doxygen $(DOXYFILE)
> +	sed -i 's/^[.]RI "[\]fI/.RI "\\fP/' $(dir)/doc/_build/man/man3/notmuch.3 

This series LGTM, and works ok... WHEN THE ABOVE LINE IS FIXED >;D

Tomi


> +
>  
>  $(dir)/version.dox: version.stamp
>  	echo "PROJECT_NAME = \"Notmuch $(VERSION)\"" > $@
> -- 
> 2.0.0.rc2
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch

^ permalink raw reply	[flat|nested] 12+ messages in thread

* [Patch v2] doc: postprocess notmuch.3
  2014-07-01 18:46         ` Tomi Ollila
@ 2014-07-01 19:13           ` David Bremner
  0 siblings, 0 replies; 12+ messages in thread
From: David Bremner @ 2014-07-01 19:13 UTC (permalink / raw)
  To: notmuch

Remove excess italics from doxygen output. It seems to make no
sense (and is certainly ugly) to italicize the first argument to the
.RI macro.
---
 doc/Makefile.local | 1 +
 1 file changed, 1 insertion(+)

diff --git a/doc/Makefile.local b/doc/Makefile.local
index e9402b4..0a0bf47 100644
--- a/doc/Makefile.local
+++ b/doc/Makefile.local
@@ -80,6 +80,7 @@ endif
 
 $(APIMAN): $(dir)/version.dox $(dir)/doxygen.cfg $(srcdir)/lib/notmuch.h
 	doxygen $(DOXYFILE)
+	perl -pi -e 's/^[.]RI "\\fI/.RI "\\fP/' $(APIMAN)
 
 $(dir)/version.dox: version.stamp
 	echo "PROJECT_NAME = \"Notmuch $(VERSION)\"" > $@
-- 
2.0.0.rc2

^ permalink raw reply related	[flat|nested] 12+ messages in thread

* Re: [PATCH 1/2] doc: build and install doxygen api docs
  2014-07-01 16:40       ` [PATCH 1/2] doc: build and install doxygen api docs David Bremner
@ 2014-07-04 11:56         ` David Bremner
  0 siblings, 0 replies; 12+ messages in thread
From: David Bremner @ 2014-07-04 11:56 UTC (permalink / raw)
  To: notmuch

David Bremner <david@tethera.net> writes:

> Add to the build-man and install-man targets. We also stop hardcoding
> the version information into doxygen.cfg

There are (at least) two outstanding issues with this patch:

- configure needs to check for doxygen and disable api docs 
  if not found.

- it doesn't work for out of tree build.

So more work for me I guess.

d

^ permalink raw reply	[flat|nested] 12+ messages in thread

end of thread, other threads:[~2014-07-04 11:57 UTC | newest]

Thread overview: 12+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-01-06  9:21 [PATCH 1/1] devel/release-checks.sh: check PROJECT_NAME in doxygen.cfg Tomi Ollila
2014-04-06  2:02 ` build and install doxygen api docs David Bremner
2014-04-06  2:02   ` [PATCH 1/2] doc: move doxgen config from devel/ to doc/ David Bremner
2014-04-08 11:19     ` David Bremner
2014-04-06  2:02   ` [PATCH 2/2] doc: build and install doxygen api docs David Bremner
2014-04-06  7:57     ` Tomi Ollila
2014-07-01 16:40     ` David Bremner
2014-07-01 16:40       ` [PATCH 1/2] doc: build and install doxygen api docs David Bremner
2014-07-04 11:56         ` David Bremner
2014-07-01 16:40       ` [PATCH 2/2] doc: postprocess notmuch.3 David Bremner
2014-07-01 18:46         ` Tomi Ollila
2014-07-01 19:13           ` [Patch v2] " David Bremner

Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).