Re: [Boost-cmake] README.txt and Welcome.txt?

Subject: Re: [Boost-cmake] README.txt and Welcome.txt?
From: Doug Gregor (doug.gregor_at_[hidden])
Date: 2008-11-02 20:30:33

On Sun, Nov 2, 2008 at 9:01 AM, Beman Dawes <bdawes_at_[hidden]> wrote:
> On Sun, Nov 2, 2008 at 8:48 AM, Doug Gregor <doug.gregor_at_[hidden]> wrote:
>>
>> On Sun, Nov 2, 2008 at 7:27 AM, Beman Dawes <bdawes_at_[hidden]> wrote:
>> > As part of the merge to trunk, two files got added to boost-root:
>> > README.txt
>> > and Welcome.txt.
>> >
>> > Was that intentional?
>>
>> Yes.
>>
>> > If so, what are these files, why are they needed, and how are they to be
>> > maintained?
>>
>> They're used to build the graphical installers. Welcome.txt is the
>> text you see when you initially open the installer, and README.txt
>> comes up as the "release notes" a little later into the installer.
>>
>> README.txt will need to be updated with the summary of what's changed
>> in each release (the same thing the release manager does for the
>> release notes on SourceForge). Welcome.txt won't change.
>
> Unless README.txt can be updated automatically, it is going to be a
> maintenance problem for release managers.

Yup, I know.

> Instead of having specific text that has to be changed each release, could
> it contain the URL of the release notes on the web site?

That doesn't really do what we want; we'd like the release notes to be
complete inside the installer.

>> If having these files in the root is bothersome, we can move them into
>> tools/build/CMake; I'd suggest doing that for Welcome.txt but not for
>> README.txt.
>
> I'm primarily worried how to keep them up to date, although it does seem
> that since stuff in tools/build/CMake depends on them, that
> tools/build/CMake is a more natural location.

That's fine by me. Or, as Daniel said, we might be able to make the
generation of README.txt part of the build for CMake.

> Also, does the installation build allow them to have comments? Particularly
> if they are not in tools/build/CMake, it might be nice if they had comments
> saying what they are and how they get maintained.

They're just text files, so there's no way to have comments without
the comments showing up in the installer.

  - Doug