BPF List
 help / color / mirror / Atom feed
From: Alejandro Colomar <alx.manpages@gmail.com>
To: Quentin Monnet <quentin@isovalent.com>,
	Alexei Starovoitov <ast@kernel.org>,
	Daniel Borkmann <daniel@iogearbox.net>,
	Andrii Nakryiko <andrii@kernel.org>
Cc: Martin KaFai Lau <kafai@fb.com>, Song Liu <songliubraving@fb.com>,
	Yonghong Song <yhs@fb.com>,
	John Fastabend <john.fastabend@gmail.com>,
	KP Singh <kpsingh@kernel.org>,
	Stanislav Fomichev <sdf@google.com>, Hao Luo <haoluo@google.com>,
	Jiri Olsa <jolsa@kernel.org>,
	bpf@vger.kernel.org
Subject: Re: [PATCH bpf-next] scripts/bpf: Fix attributes for bpf-helpers(7) man page
Date: Tue, 23 Aug 2022 17:26:54 +0200	[thread overview]
Message-ID: <a94f8c66-f53c-bd60-4567-a06a3f77acbb@gmail.com> (raw)
In-Reply-To: <593cfd34-9394-5f7c-e3b9-c4492533d030@isovalent.com>


[-- Attachment #1.1: Type: text/plain, Size: 1622 bytes --]

Hi Quentin,

On 8/23/22 17:18, Quentin Monnet wrote:
>> The versioning should always be correct.  git-describe(1) should be
>> preferred, or in absence of that, a generic (unreleased) string should
>> be used.  Describing any commit after v5.18 and before v5.19-rc1 to be
>> '5.18.0' is plain wrong/misleading.  The Makefile should probably
>> autogenerate that info from git-describe(1).  See how the Linux
>> man-pages do it (in the links above you can see it) for example.
> 
> It's not really about how to do it, more that I don't want to have a
> hard dependency on git for the script. I want it to run just as well
> when there's no Git repo around. But I can try to run "git describe" and
> fall back on the Makefile (or on an empty version) if the command fails.

Yeah, I didn't mean it's a bug in the script, but seems to me like a bug 
in the kernel Makefile.  If git fails because it's not present, there 
could be a fallback like "unknown-version".  In the man-pages, when I 
prepare the tarball, with `make dist`, I hardcode the version in the 
pages.  Maybe the kernel Makefile should have unreleased as the version 
in the git repo, and when a tarball is generated the Makefile should 
replace that unreleased version by the appropriate git version.  Since 
git will not be found in the tarballs, that version will be used in that 
case.  But when running from git, git-describe(1) should be preferred.

> 
> OK I'll prepare a new version, thanks for your help.

It's a pleasure!

Cheers,

Alex

> Quentin

-- 
Alejandro Colomar
<http://www.alejandro-colomar.es/>

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

      reply	other threads:[~2022-08-23 17:39 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-08-23  8:47 [PATCH bpf-next] scripts/bpf: Fix attributes for bpf-helpers(7) man page Quentin Monnet
2022-08-23 12:26 ` Alejandro Colomar
2022-08-23 14:23   ` Quentin Monnet
2022-08-23 15:04     ` Alejandro Colomar
2022-08-23 15:18       ` Quentin Monnet
2022-08-23 15:26         ` Alejandro Colomar [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=a94f8c66-f53c-bd60-4567-a06a3f77acbb@gmail.com \
    --to=alx.manpages@gmail.com \
    --cc=andrii@kernel.org \
    --cc=ast@kernel.org \
    --cc=bpf@vger.kernel.org \
    --cc=daniel@iogearbox.net \
    --cc=haoluo@google.com \
    --cc=john.fastabend@gmail.com \
    --cc=jolsa@kernel.org \
    --cc=kafai@fb.com \
    --cc=kpsingh@kernel.org \
    --cc=quentin@isovalent.com \
    --cc=sdf@google.com \
    --cc=songliubraving@fb.com \
    --cc=yhs@fb.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox