MIME-Version: 1.0
References: <CAMbWs4-WhpCFMbXCjtJ+FzmjfPrp7Hw1pk4p+ZpU95Kh3ofZ1A@mail.gmail.com>
 <CALj2ACU=RcL4FfKr=TJEeTWD0xz17Pt9aFP_E8SRfFdn47Wa-w@mail.gmail.com>
 <CAMbWs4930LQ2y=NYuKpnFpS90L_xWkdEMJd1ev0=ZJ=6NuAm4Q@mail.gmail.com> <CALj2ACVVhf6sU0emYgO3xEdrnh6B1GjfcbOZHvOE0F-RE=zNOA@mail.gmail.com>
In-Reply-To: <CALj2ACVVhf6sU0emYgO3xEdrnh6B1GjfcbOZHvOE0F-RE=zNOA@mail.gmail.com>
From: Richard Guo <guofenglinux@gmail.com>
Date: Tue, 12 Mar 2024 19:39:16 +0800
Message-ID: <CAMbWs49gq5dA8SVZbpP5Cnm2yXxFeJPvhApEBkE=5v2k_aYw9Q@mail.gmail.com>
Subject: Re: Regarding the order of the header file includes
To: Bharath Rupireddy <bharath.rupireddyforpostgres@gmail.com>
Cc: PostgreSQL-development <pgsql-hackers@postgresql.org>
Content-Type: multipart/alternative; boundary="00000000000055fd300613751c57"
Archived-At: <https://www.postgresql.org/message-id/CAMbWs49gq5dA8SVZbpP5Cnm2yXxFeJPvhApEBkE%3D5v2k_aYw9Q%40mail.gmail.com>
Precedence: bulk

--00000000000055fd300613751c57
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

On Fri, Mar 8, 2024 at 6:58=E2=80=AFPM Bharath Rupireddy <
bharath.rupireddyforpostgres@gmail.com> wrote:

> On Thu, Mar 7, 2024 at 12:39=E2=80=AFPM Richard Guo <guofenglinux@gmail.c=
om>
> wrote:
> >
> > While rebasing one of my patches I noticed that the header file include=
s
> > in relnode.c are not sorted in order.  So I wrote a naive script to see
> > if any other C files have the same issue.  The script is:
> >
> > #!/bin/bash
> >
> > find . -name "*.c" | while read -r file; do
> >   headers=3D$(grep -o '#include "[^>]*"' "$file" |
> >             grep -v "postgres.h" | grep -v "postgres_fe.h" |
> >             sed 's/\.h"//g')
> >
> >   sorted_headers=3D$(echo "$headers" | sort)
> >
> >   results=3D$(diff <(echo "$headers") <(echo "$sorted_headers"))
> >
> >   if [[ $? !=3D 0 ]]; then
> >     echo "Headers in '$file' are out of order"
> >     echo $results
> >     echo
> >   fi
> > done
>
> Cool. Isn't it a better idea to improve this script to auto-order the
> header files and land it under src/tools/pginclude/headerssort? It can
> then be reusable and be another code beautification weapon one can use
> before the code release.


Yeah, perhaps.  However the current script is quite unrefined and would
require a lot of effort to make it a reusable tool.  I will add it to my
to-do list and hopefully one day I can get back to it.  Feel free to
mess around with it if someone is interested.


> FWIW, I'm getting the syntax error when ran the above shell script:
>
> headerssort.sh: 10: Syntax error: "(" unexpected


I think the error is due to line 10 containing bash-style syntax.  Hmm,
have you tried to use 'bash' instead of 'sh' to run this script?

Thanks
Richard

--00000000000055fd300613751c57
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr"><div dir=3D"ltr"><br></div><div class=3D"gmail_quote"><div=
 dir=3D"ltr" class=3D"gmail_attr">On Fri, Mar 8, 2024 at 6:58=E2=80=AFPM Bh=
arath Rupireddy &lt;<a href=3D"mailto:bharath.rupireddyforpostgres@gmail.co=
m">bharath.rupireddyforpostgres@gmail.com</a>&gt; wrote:<br></div><blockquo=
te class=3D"gmail_quote" style=3D"margin:0px 0px 0px 0.8ex;border-left:1px =
solid rgb(204,204,204);padding-left:1ex">On Thu, Mar 7, 2024 at 12:39=E2=80=
=AFPM Richard Guo &lt;<a href=3D"mailto:guofenglinux@gmail.com" target=3D"_=
blank">guofenglinux@gmail.com</a>&gt; wrote:<br>
&gt;<br>
&gt; While rebasing one of my patches I noticed that the header file includ=
es<br>
&gt; in relnode.c are not sorted in order.=C2=A0 So I wrote a naive script =
to see<br>
&gt; if any other C files have the same issue.=C2=A0 The script is:<br>
&gt;<br>
&gt; #!/bin/bash<br>
&gt;<br>
&gt; find . -name &quot;*.c&quot; | while read -r file; do<br>
&gt;=C2=A0 =C2=A0headers=3D$(grep -o &#39;#include &quot;[^&gt;]*&quot;&#39=
; &quot;$file&quot; |<br>
&gt;=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0grep -v &quot;postgres.=
h&quot; | grep -v &quot;postgres_fe.h&quot; |<br>
&gt;=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0sed &#39;s/\.h&quot;//g=
&#39;)<br>
&gt;<br>
&gt;=C2=A0 =C2=A0sorted_headers=3D$(echo &quot;$headers&quot; | sort)<br>
&gt;<br>
&gt;=C2=A0 =C2=A0results=3D$(diff &lt;(echo &quot;$headers&quot;) &lt;(echo=
 &quot;$sorted_headers&quot;))<br>
&gt;<br>
&gt;=C2=A0 =C2=A0if [[ $? !=3D 0 ]]; then<br>
&gt;=C2=A0 =C2=A0 =C2=A0echo &quot;Headers in &#39;$file&#39; are out of or=
der&quot;<br>
&gt;=C2=A0 =C2=A0 =C2=A0echo $results<br>
&gt;=C2=A0 =C2=A0 =C2=A0echo<br>
&gt;=C2=A0 =C2=A0fi<br>
&gt; done<br>
<br>
Cool. Isn&#39;t it a better idea to improve this script to auto-order the<b=
r>
header files and land it under src/tools/pginclude/headerssort? It can<br>
then be reusable and be another code beautification weapon one can use<br>
before the code release.</blockquote><div><br></div><div>Yeah, perhaps.=C2=
=A0 However the current script is quite unrefined and would<br>require a lo=
t of effort to make it a reusable tool.=C2=A0 I will add it to my<br>to-do =
list and hopefully one day I can get back to it.=C2=A0 Feel free to<br>mess=
 around with it if someone is interested.<br></div><div>=C2=A0</div><blockq=
uote class=3D"gmail_quote" style=3D"margin:0px 0px 0px 0.8ex;border-left:1p=
x solid rgb(204,204,204);padding-left:1ex">
FWIW, I&#39;m getting the syntax error when ran the above shell script:<br>
<br>
headerssort.sh: 10: Syntax error: &quot;(&quot; unexpected</blockquote><div=
><br></div><div>I think the error is due to line 10 containing bash-style s=
yntax.=C2=A0 Hmm,<br>have you tried to use &#39;bash&#39; instead of &#39;s=
h&#39; to run this script?<br><br>Thanks<br>Richard<br></div></div></div>

--00000000000055fd300613751c57--