From: Jani Nikula Date: Sat, 30 Nov 2013 15:42:50 +0000 (+0200) Subject: [PATCH 0/2] library reference man page X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=2c0b4837ba06f0c0d36218bb460ba02a6588c80f;p=notmuch-archives.git [PATCH 0/2] library reference man page --- diff --git a/0e/bf9a07bb5a9faf7cf7c4a01a604bf85856dffb b/0e/bf9a07bb5a9faf7cf7c4a01a604bf85856dffb new file mode 100644 index 000000000..0ea83eb83 --- /dev/null +++ b/0e/bf9a07bb5a9faf7cf7c4a01a604bf85856dffb @@ -0,0 +1,100 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id B3FA3431FC9 + for ; Sat, 30 Nov 2013 07:43:05 -0800 (PST) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -0.7 +X-Spam-Level: +X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5 + tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id V3CGrwXr6OHN for ; + Sat, 30 Nov 2013 07:42:58 -0800 (PST) +Received: from mail-lb0-f179.google.com (mail-lb0-f179.google.com + [209.85.217.179]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 85AB3431FAF + for ; Sat, 30 Nov 2013 07:42:58 -0800 (PST) +Received: by mail-lb0-f179.google.com with SMTP id l4so7757531lbv.10 + for ; Sat, 30 Nov 2013 07:42:57 -0800 (PST) +X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; + d=1e100.net; s=20130820; + h=x-gm-message-state:from:to:cc:subject:date:message-id; + bh=v/qsVbvhuiAFb5a/LRqCc7oZkF3ao1yhgpomcoH08Vw=; + b=W05d/FuZra/+7TB9ky/r+OvvhbVm22lxJVdXpvrZ62QROb0CSD8NdA32/XbGX4hQzP + jpzw0CGeC+W6hMtf+4J3Cebip0OEKxrAXHRW48XfadT1ld4j6vZew6/VzJxDIyY9JhVK + BJZbhdR03sQEnfVvpLGF4acJYAcQoXhPRCiomu3UEc5jLGU48JhJ7DH6J6Riq/MuXc+z + FOomBnNP1yrFFzJCSqnA+4tlN1X7TtAJW8rRZmYagPMI4hZDtoEHaALPD1b+WAOejXDY + 5/Qspa5tk6SmpLyCr8EriMHDWCfScYkvq875CRAP0DGunaP2UTly/ETGnFhPRlN1ltl8 + kqRw== +X-Gm-Message-State: + ALoCoQmsDyKY/PTnxSMmPUgaVvXZ4HlUpVPUmytU2ucPD0GLzrBTf3o9n1TWboUAitBJNdhy2Bqq +X-Received: by 10.152.7.67 with SMTP id h3mr115524laa.29.1385826177059; + Sat, 30 Nov 2013 07:42:57 -0800 (PST) +Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi. + [88.195.111.91]) by mx.google.com with ESMTPSA id + sd11sm69220949lab.2.2013.11.30.07.42.55 for + (version=TLSv1.2 cipher=RC4-SHA bits=128/128); + Sat, 30 Nov 2013 07:42:56 -0800 (PST) +From: Jani Nikula +To: notmuch@notmuchmail.org +Subject: [PATCH 0/2] library reference man page +Date: Sat, 30 Nov 2013 17:42:50 +0200 +Message-Id: +X-Mailer: git-send-email 1.8.4.2 +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Sat, 30 Nov 2013 15:43:05 -0000 + +v1 after RFC at id:cover.1383758666.git.jani@nikula.org. + +These two patches add a doxygen configuration file and minimal changes +to lib/notmuch.h to produce man/man3/notmuch.3 library reference. + +Apply patches, and run + $ doxygen devel/doxygen.cfg + $ man man/man3/notmuch.3 + +There's still plenty to do, but perhaps we could get started with +merging this? There's no harm done, and would help collaboration on +this. + +TODO: + +* make this part of the build/install process +* check version in release checks +* figure out how to *not* create a file list man page +* upload the man page to the web site +* generate html pages too, and upload to web site also +* start using doxygen/javadoc tags to produce nicer output + +Cheers, +Jani. + + +Jani Nikula (2): + devel: add doxygen configuration file + lib: modify notmuch.h for automatic document generation + + devel/doxygen.cfg | 1890 +++++++++++++++++++++++++++++++++++++++++++++++++++++ + lib/notmuch.h | 436 ++++++++---- + 2 files changed, 2186 insertions(+), 140 deletions(-) + create mode 100644 devel/doxygen.cfg + +-- +1.8.4.2 +