[libvirt] [PATCH v2 3/3] docs: Document the release notes process for contributors

[John Ferlan]

On 01/05/2017 10:11 AM, Andrea Bolognani wrote:
> On Thu, 2017-01-05 at 14:55 +0000, Daniel P. Berrange wrote:
>>> This will end up on the website, so it should point to the
>>> generated HTML rather than the source XML.
>>  
>> But it means someone reading the HACKING file is being told to edit
>> the news.html file, which is going to lead to disappointment when
>> the next "make" throws away their changes regenerating from news.xml.
> 
> Thankfully all generated docs/*.html files contain a notice
> right at the very start telling the user not to change them
> directly and pointing them to the source file instead :)
> 

I would think this is simple enough to fix by adding a reference to the
file you need to change...

Thus rather than :

  <p>Don't forget to update the <a href="news.html">release notes</a>
     if your changes are significant.

perhaps use

  <p>Don't forget to update the <a href="news.html">release notes</a>
     by changing <code>docs/news.xml</code> if your changes are
     significant.


Or something like that to indicate what needs to be changed... Sure it
could be obvious by reading news.html

John

Of course if news.xml changes to news-v#.#.# as Daniel suggests, then
you have a gift that keeps giving annually to update hacking.html.in to
use the new version named file!