diff mbox

[v2,09/17] Documentation: kernel-parameters: Document owl earlycon

Message ID 20170224034055.18807-10-afaerber@suse.de (mailing list archive)
State New, archived
Headers show

Commit Message

Andreas Färber Feb. 24, 2017, 3:40 a.m. UTC
Signed-off-by: Andreas Färber <afaerber@suse.de>
---
 v1 -> v2: unchanged
 
 Documentation/admin-guide/kernel-parameters.txt | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Jonathan Corbet March 3, 2017, 10:46 p.m. UTC | #1
On Fri, 24 Feb 2017 04:40:47 +0100
Andreas Färber <afaerber@suse.de> wrote:

> +		owl,<addr>
> +			Start an early, polled-mode console on an Owl serial
> +			port at the specified address. The serial port must
> +			already be setup and configured. Options are not yet
> +			supported.
> +

Apologies, I'm just getting around to looking at this.

Is there any chance of getting a version of it that (1) has a proper
changelog, and (2) better describes the applicability of this option.
Presumably if I don't know what an "Owl serial port" is I don't need it,
but maybe a phrase saying where such ports might be found would be helpful
here?

Thanks,

jon
Andreas Färber March 3, 2017, 11:28 p.m. UTC | #2
Am 03.03.2017 um 23:46 schrieb Jonathan Corbet:
> On Fri, 24 Feb 2017 04:40:47 +0100
> Andreas Färber <afaerber@suse.de> wrote:
> 
>> +		owl,<addr>
>> +			Start an early, polled-mode console on an Owl serial
>> +			port at the specified address. The serial port must
>> +			already be setup and configured. Options are not yet
>> +			supported.
>> +
> 
> Apologies, I'm just getting around to looking at this.
> 
> Is there any chance of getting a version of it that (1) has a proper
> changelog, and (2) better describes the applicability of this option.
> Presumably if I don't know what an "Owl serial port" is I don't need it,
> but maybe a phrase saying where such ports might be found would be helpful
> here?

Note that there is already a v3 of this patch.

Both v2 and v3 do have a changelog, indicating that nothing changed here
between versions. Did you mean commit message, and if so what would you
like to see added exactly?

Did you notice that most earlycon options are described like this?
pl011, my meson, msm, lantiq all just repeat the driver name. In this
case Owl is a family of Actions Semiconductor SoCs that are newly being
enabled in this series - I can add the vendor name to the text, but no
idea what else to say about "applicability"...

While at it, it is really ugly for both users and contributors that
there is no consistent (e.g., alphabetical) order of these options.

Regards,
Andreas
diff mbox

Patch

diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index 986e443..f48a142 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -943,6 +943,12 @@ 
 			must already be setup and configured. Options are not
 			yet supported.
 
+		owl,<addr>
+			Start an early, polled-mode console on an Owl serial
+			port at the specified address. The serial port must
+			already be setup and configured. Options are not yet
+			supported.
+
 		smh	Use ARM semihosting calls for early console.
 
 		s3c2410,<addr>