devel@ where you _can_ ask
 help / color / mirror / Atom feed
From: Paul Wolneykien <manowar@altlinux.org>
To: devel-newbies@lists.altlinux.org
Subject: Re: [newbies] changelog in spec and commit message
Date: Thu, 25 Sep 2025 15:12:02 +0300
Message-ID: <20250925151202.57e9801b@legato> (raw)
In-Reply-To: <331cd651-d1dc-44d8-8e80-e6d41b398405@yandex.ru>

В Thu, 25 Sep 2025 14:33:04 +0300
Alexander Lubyagin <lubyagin@yandex.ru> пишет:

> Добрый день.
> 
> В каких случаях запись 'commit message' (git commit -m) дублирует 
> многострочную запись в spec's changelog?
> 
> В каких случаях они различаются? Есть ли рекомендации?

  Основная рекомендация по моей версии такая. Работая в git вы
комментируете свои изменения для других мэйнтейнеров (и для себя).
Проделав эту работу (или попутно) в %changelog пакета вы перечисляете
важные для пользователя изменения, переводя их на понятный пользователю
язык. Таким образом, главное в том, что целевая аудитория у git и
%changelog разная. Всегда нужно думать о том, для кого вы пишете
сообщение.

  К примеру, в git следует написать о том, что была убрана
неиспользуемая функция или забытая переменная в коде, а также о том,
что были исправлены предупреждения (warnings) во время компиляции.
Однако, поскольку для пользователя ровно ничего от этого не изменилось,
в %changelog об этом писать не следует.

  А вот если вы добавили новую переменную в конфигурационный файл, то
написать об этом в %changelog нужно обязательно. Правда относится это
только к вашим собственным изменениям: дублировать release notes из
апстрима в %changelog не нужно (он раздуется тогда до гигантских
размеров). Поэтому при тривиальном обновлении пишем просто "New
version: такая-то" или подобную запись (не регламентировано). Однако,
если сборка новой версии исправляет известную ошибку -- об этом всё
же стоит написать отдельно (с указанием номера ошибки).

  Бывают ситуации, когда в %changelog и написать особо нечего, а хотя
бы строчку написать нужно -- без этого никак. Поэтому бывают записи
наподобие "Recompiled with new libXXYY", которые для пользователя,
в общем-то, не несут никакой полезной информации.


  parent reply	other threads:[~2025-09-25 12:12 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-09-25 11:33 Alexander Lubyagin
2025-09-25 11:43 ` Anton Farygin
2025-09-25 11:44   ` Anton Farygin
2025-09-25 12:12 ` Paul Wolneykien [this message]
2025-09-25 21:24 ` Leonid Krivoshein

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250925151202.57e9801b@legato \
    --to=manowar@altlinux.org \
    --cc=devel-newbies@lists.altlinux.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

devel@ where you _can_ ask

This inbox may be cloned and mirrored by anyone:

	git clone --mirror http://lore.altlinux.org/devel-newbies/0 devel-newbies/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 devel-newbies devel-newbies/ http://lore.altlinux.org/devel-newbies \
		devel-newbies@lists.altlinux.org devel-newbies@lists.altlinux.ru devel-newbies@lists.altlinux.com
	public-inbox-index devel-newbies

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://lore.altlinux.org/org.altlinux.lists.devel-newbies


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git