amd64/boot.8: document machine gop

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

amd64/boot.8: document machine gop

Klemens Nanni-2
Back in 2017 when sending the diff[0] to implement `machine gop' I did
not know better and forgot about manual bits - here they are.

I tried adding some details to make the difference between `video' and
`gop' a tad more clearer without mentioning too much implementation
details.

Feedback? OK?

0: https://marc.info/?l=openbsd-tech&m=150557217729175

Index: arch/amd64/stand/boot/boot.8
===================================================================
RCS file: /cvs/src/sys/arch/amd64/stand/boot/boot.8,v
retrieving revision 1.27
diff -u -p -r1.27 boot.8
--- arch/amd64/stand/boot/boot.8 18 Feb 2018 07:45:39 -0000 1.27
+++ arch/amd64/stand/boot/boot.8 6 Nov 2018 19:22:42 -0000
@@ -25,7 +25,7 @@
 .\" THE POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\"
-.Dd $Mdocdate: February 18 2018 $
+.Dd $Mdocdate November 5 2018 $
 .Dt BOOT 8 amd64
 .Os
 .Sh NAME
@@ -283,12 +283,22 @@ Prints contents of processor registers i
 .Em DEBUG .
 .It Nm video Op Ar mode
 On EFI systems,
-sets the video resolution to
+sets the video resolution in columns and rows to
 .Ar mode .
 If
 .Ar mode
 is not given,
-a list of available resolutions is shown.
+a list of available modes is shown.
+.It Nm gop Op Ar mode
+On EFI systems,
+sets the video resolution in pixels to
+.Ar mode .
+If
+.Ar mode
+is not given,
+a list of available modes is shown.
+This mode is used by
+.Xr efifb 4 .
 .El
 .It reboot
 Reboots the machine by initiating a warm boot procedure.

Reply | Threaded
Open this post in threaded view
|

Re: amd64/boot.8: document machine gop

Klemens Nanni-2
On Tue, Nov 06, 2018 at 08:28:17PM +0100, Klemens Nanni wrote:
> Back in 2017 when sending the diff[0] to implement `machine gop' I did
> not know better and forgot about manual bits - here they are.
>
> I tried adding some details to make the difference between `video' and
> `gop' a tad more clearer without mentioning too much implementation
> details.
Missing double colon after Mdocdate spotted by Larry Hynes.

Index: arch/amd64/stand/boot/boot.8
===================================================================
RCS file: /cvs/src/sys/arch/amd64/stand/boot/boot.8,v
retrieving revision 1.27
diff -u -p -r1.27 boot.8
--- arch/amd64/stand/boot/boot.8 18 Feb 2018 07:45:39 -0000 1.27
+++ arch/amd64/stand/boot/boot.8 6 Nov 2018 19:49:10 -0000
@@ -25,7 +25,7 @@
 .\" THE POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\"
-.Dd $Mdocdate: February 18 2018 $
+.Dd $Mdocdate: November 5 2018 $
 .Dt BOOT 8 amd64
 .Os
 .Sh NAME
@@ -283,12 +283,22 @@ Prints contents of processor registers i
 .Em DEBUG .
 .It Nm video Op Ar mode
 On EFI systems,
-sets the video resolution to
+sets the video resolution in columns and rows to
 .Ar mode .
 If
 .Ar mode
 is not given,
-a list of available resolutions is shown.
+a list of available modes is shown.
+.It Nm gop Op Ar mode
+On EFI systems,
+sets the video resolution in pixels to
+.Ar mode .
+If
+.Ar mode
+is not given,
+a list of available modes is shown.
+This mode is used by
+.Xr efifb 4 .
 .El
 .It reboot
 Reboots the machine by initiating a warm boot procedure.

Reply | Threaded
Open this post in threaded view
|

Re: amd64/boot.8: document machine gop

Jason McIntyre-2
On Tue, Nov 06, 2018 at 08:49:33PM +0100, Klemens Nanni wrote:
> On Tue, Nov 06, 2018 at 08:28:17PM +0100, Klemens Nanni wrote:
> > Back in 2017 when sending the diff[0] to implement `machine gop' I did
> > not know better and forgot about manual bits - here they are.
> >
> > I tried adding some details to make the difference between `video' and
> > `gop' a tad more clearer without mentioning too much implementation
> > details.
> Missing double colon after Mdocdate spotted by Larry Hynes.
>

hi.

you shouldn;t touch Mdocdate - cvs updates this when you commit.

the diff reads ok. i wonder if there's a better way to distinguish
between EFI mode and EFI mode with efifb? i'm unclear on the terminology
(the whole efi thing actually) but i presumed you would be in efi mode
only when using efi framebuffer. so it seems (to me) misleading or
unclear just to talk about efi mode. perhaps you could just replace the
"On EFI systems" in the gop (what a name!) description with "On efifb(4)
systems", and save yourself a line of text?

finally the page is sorted alphabetically, so i think the gop text
should be sorted too.

jmc

> Index: arch/amd64/stand/boot/boot.8
> ===================================================================
> RCS file: /cvs/src/sys/arch/amd64/stand/boot/boot.8,v
> retrieving revision 1.27
> diff -u -p -r1.27 boot.8
> --- arch/amd64/stand/boot/boot.8 18 Feb 2018 07:45:39 -0000 1.27
> +++ arch/amd64/stand/boot/boot.8 6 Nov 2018 19:49:10 -0000
> @@ -25,7 +25,7 @@
>  .\" THE POSSIBILITY OF SUCH DAMAGE.
>  .\"
>  .\"
> -.Dd $Mdocdate: February 18 2018 $
> +.Dd $Mdocdate: November 5 2018 $
>  .Dt BOOT 8 amd64
>  .Os
>  .Sh NAME
> @@ -283,12 +283,22 @@ Prints contents of processor registers i
>  .Em DEBUG .
>  .It Nm video Op Ar mode
>  On EFI systems,
> -sets the video resolution to
> +sets the video resolution in columns and rows to
>  .Ar mode .
>  If
>  .Ar mode
>  is not given,
> -a list of available resolutions is shown.
> +a list of available modes is shown.
> +.It Nm gop Op Ar mode
> +On EFI systems,
> +sets the video resolution in pixels to
> +.Ar mode .
> +If
> +.Ar mode
> +is not given,
> +a list of available modes is shown.
> +This mode is used by
> +.Xr efifb 4 .
>  .El
>  .It reboot
>  Reboots the machine by initiating a warm boot procedure.
>