Date: Sat, 22 Apr 2017 14:19:48 -0700 From: "Ngie Cooper (yaneurabeya)" <yaneurabeya@gmail.com> To: rgrimes@freebsd.org Cc: Ngie Cooper <ngie@freebsd.org>, src-committers <src-committers@freebsd.org>, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: Re: svn commit: r317290 - head/tools/regression/geom_gpt Message-ID: <D806B8AA-E07A-4CC4-ABF1-830B23226BEA@gmail.com> In-Reply-To: <201704222109.v3ML9ahr047899@pdx.rh.CN85.dnsmgr.net> References: <201704222109.v3ML9ahr047899@pdx.rh.CN85.dnsmgr.net>
next in thread | previous in thread | raw e-mail | index | archive | help
[-- Attachment #1 --]
> On Apr 22, 2017, at 14:09, Rodney W. Grimes <freebsd@pdx.rh.CN85.dnsmgr.net> wrote:
…
> I had seen that already when I made my post, that docuement is not going
> to stop someone from going "Oh, these are out of order I am going to sort
> them since I am here" They well then probably have issues due to your next
> statement about WARNS and go hum, what is that all about. And either
> investigate and hopefully find the right thing, or do more wrong things.
>
> When #includes are out of order for good reason the source code file should
> be market as such and not dependend on the near 0 likelyhood someone
> is going to go read a man page to find out why.
The issue you’re noting is no different from someone removing/shuffling around another header in the C file. If someone does that, the least they need to do is build test their changes, and ideally they should runtime test the changes as well.
WARNS is insurance against someone sorting headers and things breaking again, because gctl_dump will not be defined (per the compiler message noted in the PR). At which point the party should do “man gctl_dump” and see the comment about stdio.h being required for it:
$ man gctl_dump
...
SYNOPSIS
/* stdio.h is only required for `gctl_dump` */
#include <stdio.h>
#include <libgeom.h>
…
Put differently, this is no different of an issue than anything else and I really don’t see the value in adding a comment stating that the order is such because of gctl_dump needing stdio.h to be #include’d first.
Thanks,
-Ngie
[-- Attachment #2 --]
-----BEGIN PGP SIGNATURE-----
Comment: GPGTools - https://gpgtools.org
iQIcBAEBCgAGBQJY+8j1AAoJEPWDqSZpMIYVSz8QAMyDE0nHWs6O3oe+3SyYovnJ
Yhqz3/FxWeId4bImQIdwMJNM6CroYHY3DkGWfnO8l7RPeKQv5R1a3sA5UvB/rPUS
oBZGWwEPAKlUL+TttI0rnNKCRSP6XyttknU2wiccpFAloBXD2aL5XTD8sbOdTgUo
Pu7t8NEXCqtG5PmDKtc5a6vl+fNl0ev3srJDAecX9J9DdaeoNAcltWOBN80HcbVU
wS3mGW3KjPAohl/cwKUyig3iVeuSZ0f0arSKVymPtFWN+4MiV5Rfifl98UrreDD5
+JpzuTMacCWZhCPlhOvohymOMFr28/VW2AOXXTJY+JEvN0yCmgNBsTYy00oZs5+I
PO6a5n/and7eRx/UmcfnxcdG639930kilmV8x3oKDzYSSz8RDCXKQAC0z1EdfF09
lkk93jQOeSvxWqi1N9rupzYuATTHS0nUWIf1Lrht1aJa+Fz4EVMEMKx3ShVW3KGK
L0v4dYGT5lveTFOQ6xjRKx2wjKLP3XhDx9d29lReOZE/iIxXi/EZdmLzQ2LsvMVr
pyDAF3YGQSNtyYq+MEGpINaPNNYWb6B9TGVlqgBBneaIYOeB9Mj8fpilvJK5uT35
0A9I3gvzpGTZeypMbo10vg3y73TxrLh5hX9OWLLVJHxqFdoDhp+rLpCB3CEtJTRB
kQ6E2RGZYnENvRkgmn4v
=PXbU
-----END PGP SIGNATURE-----
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?D806B8AA-E07A-4CC4-ABF1-830B23226BEA>