All of lore.kernel.org
 help / color / mirror / Atom feed
From: Dave Martin <Dave.Martin@arm.com>
To: Walter Harms <wharms@bfs.de>
Cc: Michael Kerrisk <mtk.manpages@gmail.com>,
	Catalin Marinas <catalin.marinas@arm.com>,
	Will Deacon <will@kernel.org>,
	Vincenzo Frascino <vincenzo.frascino@arm.com>,
	"linux-man@vger.kernel.org" <linux-man@vger.kernel.org>,
	"linux-arch@vger.kernel.org" <linux-arch@vger.kernel.org>,
	"linux-arm-kernel@lists.infradead.org" 
	<linux-arm-kernel@lists.infradead.org>
Subject: Re: Adding arch-specific user ABI documentation in linux-man
Date: Tue, 5 May 2020 11:55:24 +0100	[thread overview]
Message-ID: <20200505105522.GL30377@arm.com> (raw)
In-Reply-To: <32259f3763344500a058a8ca8a3a33d8@bfs.de>

On Tue, May 05, 2020 at 07:45:32AM +0000, Walter Harms wrote:
> Hi Dave,
> you are pointing to an (IMHO) interesting question.
> How to document different CPUs ?
> Given that an operating system should hide the different CPU's using
> CPU specific features should be used sparsely at best.

Agreed!  But there are real situations where cpu specifics can't be
avoided, and having documentation will help people to use those features
correctly.

> the easy part are adds-on like flags for prctrl etc. simply add it to the page.

For prctl, that makes sense (it's a jumble of arch specifics already).

But would it be considered a problem if the ptrace page, say, becomes
80% arch-specific stuff?  That page is cumbersome enough already...

> Other things should go to a cpu specific pages (can of worms). The problem will
> be to keep that small but informative. I have no idea about the level of detail
> (and i have worked with a range of CPUs) that could be interesting for a programmer.
> An of cause every other CPU now needs also a page.

Fair enough.

Cheers
---Dave

WARNING: multiple messages have this Message-ID (diff)
From: Dave Martin <Dave.Martin-5wv7dgnIgG8@public.gmane.org>
To: Walter Harms <wharms-fPG8STNUNVg@public.gmane.org>
Cc: Michael Kerrisk
	<mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>,
	Catalin Marinas <catalin.marinas-5wv7dgnIgG8@public.gmane.org>,
	Will Deacon <will-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>,
	Vincenzo Frascino
	<vincenzo.frascino-5wv7dgnIgG8@public.gmane.org>,
	"linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org"
	<linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>,
	"linux-arch-u79uwXL29TY76Z2rM5mHXA@public.gmane.org"
	<linux-arch-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>,
	"linux-arm-kernel-IAPFreCvJWM7uuMidbF8XUB+6BGkLq7r@public.gmane.org"
	<linux-arm-kernel-IAPFreCvJWM7uuMidbF8XUB+6BGkLq7r@public.gmane.org>
Subject: Re: Adding arch-specific user ABI documentation in linux-man
Date: Tue, 5 May 2020 11:55:24 +0100	[thread overview]
Message-ID: <20200505105522.GL30377@arm.com> (raw)
In-Reply-To: <32259f3763344500a058a8ca8a3a33d8-fPG8STNUNVg@public.gmane.org>

On Tue, May 05, 2020 at 07:45:32AM +0000, Walter Harms wrote:
> Hi Dave,
> you are pointing to an (IMHO) interesting question.
> How to document different CPUs ?
> Given that an operating system should hide the different CPU's using
> CPU specific features should be used sparsely at best.

Agreed!  But there are real situations where cpu specifics can't be
avoided, and having documentation will help people to use those features
correctly.

> the easy part are adds-on like flags for prctrl etc. simply add it to the page.

For prctl, that makes sense (it's a jumble of arch specifics already).

But would it be considered a problem if the ptrace page, say, becomes
80% arch-specific stuff?  That page is cumbersome enough already...

> Other things should go to a cpu specific pages (can of worms). The problem will
> be to keep that small but informative. I have no idea about the level of detail
> (and i have worked with a range of CPUs) that could be interesting for a programmer.
> An of cause every other CPU now needs also a page.

Fair enough.

Cheers
---Dave

WARNING: multiple messages have this Message-ID (diff)
From: Dave Martin <Dave.Martin@arm.com>
To: Walter Harms <wharms@bfs.de>
Cc: "linux-arch@vger.kernel.org" <linux-arch@vger.kernel.org>,
	"linux-man@vger.kernel.org" <linux-man@vger.kernel.org>,
	Catalin Marinas <catalin.marinas@arm.com>,
	Michael Kerrisk <mtk.manpages@gmail.com>,
	Vincenzo Frascino <vincenzo.frascino@arm.com>,
	Will Deacon <will@kernel.org>,
	"linux-arm-kernel@lists.infradead.org"
	<linux-arm-kernel@lists.infradead.org>
Subject: Re: Adding arch-specific user ABI documentation in linux-man
Date: Tue, 5 May 2020 11:55:24 +0100	[thread overview]
Message-ID: <20200505105522.GL30377@arm.com> (raw)
In-Reply-To: <32259f3763344500a058a8ca8a3a33d8@bfs.de>

On Tue, May 05, 2020 at 07:45:32AM +0000, Walter Harms wrote:
> Hi Dave,
> you are pointing to an (IMHO) interesting question.
> How to document different CPUs ?
> Given that an operating system should hide the different CPU's using
> CPU specific features should be used sparsely at best.

Agreed!  But there are real situations where cpu specifics can't be
avoided, and having documentation will help people to use those features
correctly.

> the easy part are adds-on like flags for prctrl etc. simply add it to the page.

For prctl, that makes sense (it's a jumble of arch specifics already).

But would it be considered a problem if the ptrace page, say, becomes
80% arch-specific stuff?  That page is cumbersome enough already...

> Other things should go to a cpu specific pages (can of worms). The problem will
> be to keep that small but informative. I have no idea about the level of detail
> (and i have worked with a range of CPUs) that could be interesting for a programmer.
> An of cause every other CPU now needs also a page.

Fair enough.

Cheers
---Dave

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

  reply	other threads:[~2020-05-05 10:55 UTC|newest]

Thread overview: 38+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-05-04 15:32 RFC: Adding arch-specific user ABI documentation in linux-man Dave Martin
2020-05-04 15:32 ` Dave Martin
2020-05-05  7:45 ` AW: " Walter Harms
2020-05-05  7:45   ` Walter Harms
2020-05-05  7:45   ` Walter Harms
2020-05-05  7:45   ` Walter Harms
2020-05-05 10:55   ` Dave Martin [this message]
2020-05-05 10:55     ` Dave Martin
2020-05-05 10:55     ` Dave Martin
2020-05-05 10:55     ` Dave Martin
2020-05-05 10:44 ` RFC: " Will Deacon
2020-05-05 10:44   ` Will Deacon
2020-05-05 11:05   ` Dave Martin
2020-05-05 11:05     ` Dave Martin
2020-05-05 11:05     ` Dave Martin
2020-05-05 12:14     ` Will Deacon
2020-05-05 12:14       ` Will Deacon
2020-05-05 12:14       ` Will Deacon
2020-05-06 10:47     ` Michael Kerrisk (man-pages)
2020-05-06 10:47       ` Michael Kerrisk (man-pages)
2020-05-05 12:43   ` Russell King - ARM Linux admin
2020-05-05 12:43     ` Russell King - ARM Linux admin
2020-05-05 12:43     ` Russell King - ARM Linux admin
2020-05-05 13:06     ` Will Deacon
2020-05-05 13:06       ` Will Deacon
2020-05-05 13:16       ` Russell King - ARM Linux admin
2020-05-05 13:16         ` Russell King - ARM Linux admin
2020-05-05 13:16         ` Russell King - ARM Linux admin
2020-05-06 10:47     ` Michael Kerrisk (man-pages)
2020-05-06 10:47       ` Michael Kerrisk (man-pages)
2020-05-06 10:47   ` Michael Kerrisk (man-pages)
2020-05-06 10:47     ` Michael Kerrisk (man-pages)
2020-05-06 10:47 ` Michael Kerrisk (man-pages)
2020-05-06 10:47   ` Michael Kerrisk (man-pages)
2020-05-06 10:47   ` Michael Kerrisk (man-pages)
2020-05-06 14:29   ` Dave Martin
2020-05-06 14:29     ` Dave Martin
2020-05-06 14:29     ` Dave Martin

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=20200505105522.GL30377@arm.com \
    --to=dave.martin@arm.com \
    --cc=catalin.marinas@arm.com \
    --cc=linux-arch@vger.kernel.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-man@vger.kernel.org \
    --cc=mtk.manpages@gmail.com \
    --cc=vincenzo.frascino@arm.com \
    --cc=wharms@bfs.de \
    --cc=will@kernel.org \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.