From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <olivier.matz@6wind.com>
Received: from mail-wg0-f53.google.com (mail-wg0-f53.google.com [74.125.82.53])
 by dpdk.org (Postfix) with ESMTP id 44B19156
 for <dev@dpdk.org>; Thu,  7 Nov 2013 10:26:38 +0100 (CET)
Received: by mail-wg0-f53.google.com with SMTP id y10so255202wgg.20
 for <dev@dpdk.org>; Thu, 07 Nov 2013 01:27:31 -0800 (PST)
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20130820;
 h=x-gm-message-state:message-id:date:from:user-agent:mime-version:to
 :cc:subject:references:in-reply-to:content-type
 :content-transfer-encoding;
 bh=BekUjMY+usGyb+BOoveKrqsREd5zof2xChgTzV3wtBk=;
 b=lcDvZ4E1MSldjEna2Citu/n2EjqqWE6G5UPem8wJCtl5WgQ2bIrGI4MBpWewTF6ilx
 7zIFrGVh8tGkJODgl9IeBdb+Y9YzhCT9OOUBWqbhjVuKMHla3WczGZcB8UAHXZx72B7O
 nlRV820XbBxQpp65N+xul+zK9Z8yyqLRkooXJO0xp85sGsHs0Ws7u/7S7V85HWdX/Qwe
 knvHu4kep+QvsxTOyk01rx4VDK0vpy+KbLOrMxiq9lqji/gYLkekWEg5F2CxT68oWhwi
 yCBtSe8EDJBROkXuHaJC/X+WKbTei3/1KQAb6IJMp30168WU9DCN4+F2DAL+a41K3WF+
 lFaA==
X-Gm-Message-State: ALoCoQkmiPjyTJcq89YCx6lhUblrL1Qwp52fcmau6gAsu9pdMTeaiDhxk6ewoPpEQOA5x+UpbfhQ
X-Received: by 10.180.36.105 with SMTP id p9mr1879654wij.2.1383816451841;
 Thu, 07 Nov 2013 01:27:31 -0800 (PST)
Received: from [10.16.0.195] (6wind.net2.nerim.net. [213.41.180.237])
 by mx.google.com with ESMTPSA id ll10sm33699568wic.9.2013.11.07.01.27.28
 for <multiple recipients>
 (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128);
 Thu, 07 Nov 2013 01:27:30 -0800 (PST)
Message-ID: <527B5CFB.9000904@6wind.com>
Date: Thu, 07 Nov 2013 10:27:23 +0100
From: Olivier MATZ <olivier.matz@6wind.com>
User-Agent: Mozilla/5.0 (X11; Linux x86_64;
 rv:17.0) Gecko/20131005 Icedove/17.0.9
MIME-Version: 1.0
To: Thomas Monjalon <thomas.monjalon@6wind.com>
References: <1383650075-30182-1-git-send-email-thomas.monjalon@6wind.com>
In-Reply-To: <1383650075-30182-1-git-send-email-thomas.monjalon@6wind.com>
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit
Cc: dev@dpdk.org
Subject: Re: [dpdk-dev] [PATCH] doc: fix doxygen parsing of __attribute__
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Thu, 07 Nov 2013 09:26:38 -0000

Hi Thomas,

 > Ignore __attribute__ because it was wrongly parsed as an identifier.
>
> Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>

What about prefixing the title by "doc: " and remove the dot at the
end of the line ?

> --- a/doc/doxy-api.conf
> +++ b/doc/doxy-api.conf
> @@ -47,9 +47,13 @@ INPUT                   = doc/doxy-api-index.md \
>   FILE_PATTERNS           = rte_*.h \
>                             cmdline.h
>   PREDEFINED              = __DOXYGEN__ \
> +                          __attribute__(x)= \
>                             RTE_MBUF_SCATTER_GATHER
>
>   OPTIMIZE_OUTPUT_FOR_C   = YES
> +ENABLE_PREPROCESSING    = YES
> +MACRO_EXPANSION         = YES
> +EXPAND_ONLY_PREDEF      = YES
>   EXTRACT_STATIC          = YES
>   HIDE_UNDOC_MEMBERS      = YES
>   HIDE_UNDOC_CLASSES      = YES

I think you should provide a pointer to the doxygen documentation
in the commit log to explain the modification. Maybe this one is
appropriate:
http://www.stack.nl/~dimitri/doxygen/manual/preprocessing.html

About the patch itself, it looks good to me.

Olivier