DRAFT: Port Tools/gittools/git-subsystems-split to Python

[cclauss]

As discussed at:

• Fix typos discovered by codespell #29714 (comment)

Let's try to port Tools/gittools/git-subsystems-split to Python. This contains several building blocks but does not yet:

• Enable the commit message editing functionality --> edit_subsystems_split_message()
• get_subsystems() does not properly yield all subsystems (e.g., autotest, etc.)
• Enable the creation of the multiple commits.

Basicly

ardupilot/Tools/gittools/git-subsystems-split

Lines 64 to 87 in 5233716

	if $option_edit; then
	if [[ -z $EDITOR ]]; then
	echo "Environment variable EDITOR is required for option --edit." >&2
	exit 1
	fi
	($EDITOR "$MSG_FILE")
	elif ! $option_copy; then
	if head -n 1 "$MSG_FILE" | grep "^[^: ]\+\s*:" -q; then
	sed '1 s,^[^: ]\+\s*,$subsystem,' -i "$MSG_FILE"
	else
	buff_file="$(mktemp)"
	awk '
	NR == 1 {
	l=sub(/^\s\+/, "", $line);
	print "$subsystem: " \
	tolower(substr($l, 1, 1)) \
	substr($l, 2);
	}
	NR != 1
	' "$MSG_FILE" > "$buff_file"
	mv "$buff_file" "$MSG_FILE"
	rm "$buff_file"
	fi
	fi

[peterbarker]

I like the concept, and mentioned a rewrite into Python was a good idea to @Hwurzburg yesterday. We need to be a bit more nuanced with some of the commits now-adays (eg. the prefix for a change made to board definitions under libraries/AP_HAL_ChibiOS/hwdef/ should be prefixd with hwdef not AP_HAL_ChibiOS. Translating to Python would be a prerequisite for that sort of change IMO.

[cclauss]

I see elsewhere that gawk is used instead of awk. Would that be a quick fix to my macOS issue?

Are the desired subsystem prefixes documented somewhere? What would the prefix be for files at the root (like #29734)? If someone can document desired subsystem prefixes that would move this forward.

All the logging can be stripped away but helps while this is still a draft.

I will work offline on the creation of multiple commits.

If anyone sees a more direct way to achieve this objective then I would be ok with closing this pr.

[tridge]

@cclauss I'm delighted to see this work! I was thinking of doing this myself, but happy for you to do it.
just put an easy to edit dictionary in the script for the mappings for special directories
for files at root, the only one regulary edited is wscript, which I normally prefix as "waf: xxxx"

[peterbarker]

.... edits to Tools/ardupilotwaf/** also usually get labelled with waf:.

[cclauss]

@tridge wrote:

just put an easy to edit dictionary in the script for the mappings for special directories

Please read thru the get_commit_prefix_from_filepath() logic. I harvested several of your open PRs to get a hint about prefix logic.