From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-qk1-x72b.google.com (mail-qk1-x72b.google.com [IPv6:2607:f8b0:4864:20::72b]) by sourceware.org (Postfix) with ESMTPS id ECA07384B0C0 for ; Wed, 17 Mar 2021 15:22:50 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org ECA07384B0C0 Received: by mail-qk1-x72b.google.com with SMTP id n79so39230472qke.3 for ; Wed, 17 Mar 2021 08:22:50 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:subject:to:cc:references:from:message-id:date :user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=BrQW+tuleb59fHmEUFgYspp6O2Y2X5kFVc7W1Z3stFQ=; b=HAmiTvYdsJUT/qLl262W+XuOb3SZArgAGcNfLde3iivjCkeROBAUNh82dgRWhft7gd VD0AmvujVaJA14LCneUskNl5JDmm6dQf7jVeWUswl8krBNRSH9ZemRymf7l6YUh4moe8 LSsvTYhR1o2mgJm4kHc45yL9PJ0BJIyPYQmpmNkTzrcQzuxnEY0hzfDMbtrCG8gZVasS ov6f+1GpNW7smZkQEiWqhQ5jnstF+Hoa8hNl6/+MxM9NoaPEI9MnMWoVIMlhttXXLaQB AWlR68vAzKVS6MdnJYfinPIk3zvAeT2jNUr8pFknyEmUz5QOyKFprMLNAIVQruL1Ciyr tHZA== X-Gm-Message-State: AOAM532wKVcxWKFL6t3agy6QtBX3ceAPIN9UafEDS9kDNdGQgFQvDkPi NmeHprkjpTrlmPHkKYZz+ukAPxFRObXrCA== X-Google-Smtp-Source: ABdhPJze/JLoEn8wxOi9PrQorqy0VjetPaueGAl5KQbEqtsAL4aoaNl4et32b7anyC6iWB6SlQym2g== X-Received: by 2002:a05:620a:2455:: with SMTP id h21mr5317712qkn.447.1615994570480; Wed, 17 Mar 2021 08:22:50 -0700 (PDT) Received: from ?IPv6:2804:7f0:4841:2841:c502:89bb:c3bf:f9a1? ([2804:7f0:4841:2841:c502:89bb:c3bf:f9a1]) by smtp.gmail.com with ESMTPSA id t5sm14203999qkt.66.2021.03.17.08.22.47 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Wed, 17 Mar 2021 08:22:49 -0700 (PDT) Subject: Re: sim: replacing ChangeLog files with online git logs To: Eli Zaretskii Cc: vapier@gentoo.org, gdb@sourceware.org References: <83ft0zjys1.fsf@gnu.org> <83lfarhwjq.fsf@gnu.org> <83eegjhuuq.fsf@gnu.org> <8335wyj461.fsf@gnu.org> <83tup9disi.fsf@gnu.org> <2012fb21-38f2-3d1c-62c8-52d94d19e243@linaro.org> <83pmzxdegd.fsf@gnu.org> <83o8fhddg3.fsf@gnu.org> From: Luis Machado Message-ID: <18f4f0e2-0a35-a6c5-1886-943f81f817fd@linaro.org> Date: Wed, 17 Mar 2021 12:22:46 -0300 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.7.1 MIME-Version: 1.0 In-Reply-To: <83o8fhddg3.fsf@gnu.org> Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit X-Spam-Status: No, score=-5.0 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, NICE_REPLY_A, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=ham autolearn_force=no version=3.4.2 X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on server2.sourceware.org X-BeenThere: gdb@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 17 Mar 2021 15:22:52 -0000 On 3/17/21 12:09 PM, Eli Zaretskii wrote: >> Cc: vapier@gentoo.org, gdb@sourceware.org >> From: Luis Machado >> Date: Wed, 17 Mar 2021 11:52:03 -0300 >> >>> That's the idea, yes. Of course, for such a generated ChangeLog to be >>> useful, the Git commit log messages should be informative enough. >> >> I see. Given the ChangeLog will list all the files that were changed, I >> suppose the commit messages would only need to describe what the changes >> are about. But the description may not list function names, files, new >> data structures etc. Would that work? >> >> Or did you have something more specific in mind? > > Ideally, the commit log messages should provide the same information > as the manually managed ChangeLog files, in which case generating the > files from Git log at release time doesn't lose any information. If > some of that information is missing from the Git logs, then the > generated ChangeLog files will be somewhat less useful. But if the > project doesn't require to record more than that in Git log messages, > then it's the problem with the Git logs, not with ChangeLogs. The commit message, at least for the GDB project, includes a subject line, the description of the changes and an embedded ChangeLog entry. So there are 3 sections. sim/ seems to follow the same strategy. Given the idea is to drop ChangeLog files for sim/ (for reasons Mike has exposed), it would make no sense to keep embedding a manually-written ChangeLog entry in the git commit message. So the only two sections left in the commit message would be the subject line and the description. The list of changes would be auto-generated by a script, but it will certainly be less descriptive than a manually-written ChangeLog entry. It will only list things like "modified" or "new file". > > For example, in Emacs we ask contributors to format the Git log > messages according to ChangeLog format, and then the generated > ChangeLog file looks exactly like the manual one would. > I may be mistaken, but I think the idea is to drop ChangeLog dependencies even from commit messages. That will simplify the contribution process given ChangeLog files/entries will be auto-generated by the mentioned script.