Hi Amit, On Fri, Sep 27, 2019 at 12:10 AM Amit Langote <amitlangot...@gmail.com> wrote: > > Hi Shiraishi-san, > > On Thu, Sep 26, 2019 at 6:32 PM Youki Shiraishi <shirai...@computer.org> > wrote: > > On Thu, Sep 26, 2019 at 5:38 PM Amit Langote <amitlangot...@gmail.com> > > wrote: > > > On Thu, Sep 26, 2019 at 3:06 PM Youki Shiraishi <shirai...@computer.org> > > > wrote: > > > > I have just started to read the PostgreSQL code and found a lack of > > > > comments for a postgres backend program in bootstrap mode. > > > > When I saw the --boot option implemented in src/backend/main/main.c at > > > > first time, I did not understand why the --boot option is not > > > > documented and what it is used for. > > > > The only way to know these things is to type `grep -r '\--boot' .` on a > > > > project root. > > > > It is easy to see that the --boot option is used in initdb for some > > > > historical reasons, but it is painful for a beginner like me. > > > > I believe the attached patch which adds a few comments might help a > > > > beginner. > > > > > > Thanks for the patch. It might be a good idea to demystify this > > > secret --boot option. > > > > > > + /* Bootstrap mode for initdb */ > > > if (argc > 1 && strcmp(argv[1], "--boot") == 0) > > > AuxiliaryProcessMain(argc, argv); /* does not return */ > > > else if (argc > 1 && strcmp(argv[1], "--describe-config") == 0) > > > > > > How about expanding that comment just a little bit, say: > > > > > > /* > > > * Bootstrapping is handled by AuxiliaryProcessMain() for historic > > > * reasons. > > > */ > > Do you any thoughts on this suggestion?
Sorry, I missed your suggestion. The purpose of a comment here is to direct hackers to initdb.c because the --boot option is used only by initdb. initdb.c describes why it uses the --boot option (i.e., historical reason), so I think it should not be described in main.c. Regards, -- Youki Shiraishi NTT Software Innovation Center Phone: +81-(0)3-5860-5115 Email: shirai...@computer.org
