Received: by 2002:a05:6a10:16a7:0:0:0:0 with SMTP id gp39csp2704827pxb;
        Sun, 15 Nov 2020 14:58:55 -0800 (PST)
X-Google-Smtp-Source: ABdhPJxAiRrQ2RGP4/8hbGqD95OqnFd57uMwu9mUO61wjaQZ6EdxrPvQTcbWGRUzQMTKtgaCBoGL
X-Received: by 2002:a17:906:745:: with SMTP id z5mr12632742ejb.408.1605481134878;
        Sun, 15 Nov 2020 14:58:54 -0800 (PST)
ARC-Seal: i=1; a=rsa-sha256; t=1605481134; cv=none;
        d=google.com; s=arc-20160816;
        b=lrI6uwlDjbh+2Iq/SBdgfHZexuU2uXEfvKgTtCGvg2MR+RYF1WjYKh1YB4Yq7mHlEs
         VwFSLN3mXc4sztRlR34HHuBe+IcuYHL5hWwOvhH1Fbb26cUZ7dYPEVo0bFB1VzHHbfUX
         Cy3kKuaiNkxo6LhVWlPptzYgwDKvrFmTb3mGveR6IciSCXOengQ9B2Z/QEoAUwqEh2U+
         Y0vlGsVMcTCSFTlyWqww6uE4KN4Yvm7DZhlFz7RhpPKMzK5lukxA1f+lUAwC/lgAhZjU
         a+cZ44ppTJkTl+n6CS9o5PuQvcv/WAAulI0+IM8d1mojsg7sPQh5IjgHkumQ/qOGCKOF
         PTdQ==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816;
        h=list-id:precedence:mime-version:message-id:date:references
         :in-reply-to:subject:cc:to:dkim-signature:dkim-signature:from;
        bh=aCVZT0RB6+oi1VWVJCZcccG/G67XqRX9rnw94MVyt48=;
        b=C99INwY9olfXgzwnZx5uAeigApcRP+zUbnGv8eTSd4KhbQXDdZGx4DlQR/9Zie9+Zp
         sPy3tTCfaJNo7FpUoSZ6crb0AxD6QYOBHNBH07eyQLWEQnKomXS9lLxKc3+1oOzBdccl
         u4aIkYK0bHsoabhKyAPnKrhd+9eilheMhthsF0SSNn7qYAEZk/xlD2Kj4qgY1Hwd3otq
         C6W0AkdwhUKAO7EU5FXwiD3q4KD5uYqGupuhHNnm9R+cBTUU4PEGQ128mG13FtKbBW8k
         WefpNOhb6rv6jqLsTbOV6Yj2Me3/ug4vRYecGvDUUURFYhQ98LYPzdv+VxXefJiEU0Hj
         8L/w==
ARC-Authentication-Results: i=1; mx.google.com;
       dkim=pass header.i=@linutronix.de header.s=2020 header.b=fy9Ht8N0;
       dkim=neutral (no key) header.i=@linutronix.de header.s=2020e;
       spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org;
       dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de
Return-Path: <linux-kernel-owner@vger.kernel.org>
Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18])
        by mx.google.com with ESMTP id i9si10266905eje.410.2020.11.15.14.58.32;
        Sun, 15 Nov 2020 14:58:54 -0800 (PST)
Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Authentication-Results: mx.google.com;
       dkim=pass header.i=@linutronix.de header.s=2020 header.b=fy9Ht8N0;
       dkim=neutral (no key) header.i=@linutronix.de header.s=2020e;
       spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org;
       dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
        id S1727983AbgKOW2T (ORCPT <rfc822;sbrunau@gmail.com> + 99 others);
        Sun, 15 Nov 2020 17:28:19 -0500
Received: from Galois.linutronix.de ([193.142.43.55]:37426 "EHLO
        galois.linutronix.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org
        with ESMTP id S1727976AbgKOW2T (ORCPT
        <rfc822;linux-kernel@vger.kernel.org>);
        Sun, 15 Nov 2020 17:28:19 -0500
From:   Thomas Gleixner <tglx@linutronix.de>
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linutronix.de;
        s=2020; t=1605479290;
        h=from:from:reply-to:subject:subject:date:date:message-id:message-id:
         to:to:cc:cc:mime-version:mime-version:content-type:content-type:
         in-reply-to:in-reply-to:references:references;
        bh=aCVZT0RB6+oi1VWVJCZcccG/G67XqRX9rnw94MVyt48=;
        b=fy9Ht8N0vPnGo4+FXDiJJlQcBWvtM43kSPQxu52DLgwbVblugCikHP0tKKV0/wy/9nu4dZ
        IxICeC8on0PvIO48Dtad0vxV1Cq9TkZxX0mFJp7xidaY1DGzN2ou4YOyQTYLLdcSqe8c+Y
        +WfnbvPM47oYj/SvUePyByCyG59IXOvOU+UiqsXrqf8hUmbflGRj9Fel7SjJ9TBP5l/CMy
        RzM+apg5CejT4SPfqVZ4T13jTiUlpdiXwjzpLzTjDzXshlThlRJHjftwOvd5V3hn1P4XJx
        CHzE4FIscyiSSG67GEIvd67xsRlGoHZiyt5aoRRk12X/a9Cp8xN7aDR0RImrPg==
DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=linutronix.de;
        s=2020e; t=1605479290;
        h=from:from:reply-to:subject:subject:date:date:message-id:message-id:
         to:to:cc:cc:mime-version:mime-version:content-type:content-type:
         in-reply-to:in-reply-to:references:references;
        bh=aCVZT0RB6+oi1VWVJCZcccG/G67XqRX9rnw94MVyt48=;
        b=K8eMTuvY8xPsDZzP6Po0hLshFq7mz5aMX3B6N4LlwgD9mMZvG4VlINkFrCTms0ZNGk1NVr
        5kXiTzDYka4HdpCg==
To:     Alex Shi <alex.shi@linux.alibaba.com>, john.stultz@linaro.org
Cc:     Stephen Boyd <sboyd@kernel.org>, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 3/6] timekeeping: add kernel-doc markup for pvclock notifier
In-Reply-To: <1605252275-63652-3-git-send-email-alex.shi@linux.alibaba.com>
References: <1605252275-63652-1-git-send-email-alex.shi@linux.alibaba.com> <1605252275-63652-3-git-send-email-alex.shi@linux.alibaba.com>
Date:   Sun, 15 Nov 2020 23:28:10 +0100
Message-ID: <87zh3i45mt.fsf@nanos.tec.linutronix.de>
MIME-Version: 1.0
Content-Type: text/plain
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On Fri, Nov 13 2020 at 15:24, Alex Shi wrote:
>  /**
>   * pvclock_gtod_register_notifier - register a pvclock timedata update listener
> + * @nb: a notifier entry which register on pvclock_gtod_chain.

What is a notifier entry? The struct is named notifier_block and the
argument is a pointer to a notifier block. So why making things up?

Also it's completely irrelevant for the reader to know about the name of
the notifier chain. The function documentation says:

         register a pvclock timedata update listener

which precisely describes what the function does. pvclock_gtod_chain is
an internal implementation detail and nothing external can depend on it.
It could be renamed to 'foo_bar' and the function would still do the
same thing.

* @nb: Notifier block to register

is precise and good enough, isn't it?

Thanks,

        tglx