Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

iwlwifi crash on serw12 during upload test after suspend/resume #4

Open
jacobgkau opened this issue Sep 10, 2020 · 0 comments
Open

iwlwifi crash on serw12 during upload test after suspend/resume #4

jacobgkau opened this issue Sep 10, 2020 · 0 comments

Comments

@jacobgkau
Copy link
Member

On serw12 with AX200NGW, after performing at least one suspend/resume and then running speedtest.net several times, iwlwifi crashes during the upload portion of the test (causing the test to freeze) and sometimes requires manually disconnecting/reconnecting to the network in order to recover.

Discovered this while testing #3, but it occurs before and after that update.

We're seeing this on two separate units (the 1660 Ti version that I have and the 2070 version that @leviport has), so we don't think it's a hardware defect.

dmesg logs from some of the crashes (the crash looks nearly identical in every case):
iwlwifi-crash-1.txt
iwlwifi-crash-2.txt
iwlwifi-crash-3-nonfatal.txt
iwlwifi-crash-4.txt
iwlwifi-crash-5.txt

Crash #3 did not include the line iwlwifi 0000:05:00.0: Failed to send recovery cmd blob was invalid 1 at the end, and it seemed to recover quicker than the others (it did not require disconnecting/reconnecting to recover.)

Steps to reproduce:

  • Boot and suspend/resume at least once
  • Run a download+upload speed test (can take 2-4 tests to fail)
  • If the crash does not occur, try suspending/resuming again and then running more speed tests
jackpot51 pushed a commit that referenced this issue Mar 18, 2022
UBUNTU: [Documentation] Justification for removal of UBUNTU commits
80f2c36 
This is an empty commit for documentation purposes only.

Historically, some old and unused firmware was removed by directly purging
the firmware files from the repo with UBUNTU commits or by reverting the
relevant upstream commits. Subsequent UBUNTU commits cleaned up the WHENCE
file and removed stale entries so that the check-whence.py checker is
happy.

Recent changes introduced the concept of listing firmware files, that
should not be packaged, in a separate file debian/remove-firmware.list.
These changes also included the reverting of the above mentioned commits
and the addition of the 'removed' firmware files to remove-firmware.list so
that the resulting package content doesn't change.

With that, we ended up with 5 commits per firmware removal set:
  1) The original firmware removal commit
  2) The subsequent WHENCE fixup
  3) The revert of #2
  4) The revert of #1
  5) The addition of the 'removed' firmware files to remove-firmware.list

This is not ideal since a) upstream files are modified (WHENCE) and deleted
for the sole purpose of not packaging them and b) because of that,
subsequent rebases to latest upstream could result in conflicts.

For these reasons, it was decided to alter the history of this branch and
remove commits #1 to #4 and only keep #5. Note that some of the #1 commits
unfortunately touched both upstream and UBUNTU files. Only the
modifications of upstream files was removed, the UBUNTU modifications
needed to be kept.

Both branch commits (before and after the rebase and removal of commits)
are tagged and it was verified, that the repo content at these tags is
identical (except for debian/changelog). More specifically, the 'before'
tag is:
  Ubuntu-20220217.git6342082c-0ubuntu2
and the 'after' tag is:
  Ubuntu-20220217.git6342082c-0ubuntu3

$ git diff --name-only Ubuntu-20220217.git6342082c-0ubuntu2 Ubuntu-20220217.git6342082c-0ubuntu3
debian/changelog

Removed #1 commits:

563bb48ed143 ("UBUNTU: Remove amd64-microcode")
251237583bdd ("UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices"")
513a97a03fba ("UBUNTU: Remove obsolete bnx2x firmware files")
935dc770957e ("UBUNTU: Remove obsolete tr_smctr firmware")
1be4f28f91fb ("UBUNTU: Remove obsolete ti-connectivity firmware")
3d183a325fec ("UBUNTU: Remove obsolete tda1004x firmware")
09e02976b05b ("UBUNTU: Remove obsolete sxg firmware")
9b6d6bbcbc18 ("UBUNTU: Remove obsolete myricom firmware")
bfa2ac04ade6 ("UBUNTU: Remove obsolete mwl8k firmware")
a46068ae4580 ("UBUNTU: Remove obsolete libertas firmware")
1faeeb10de57 ("UBUNTU: Remove obsolete Computone firmware")
22f2239919d9 ("UBUNTU: Remove obsolete dabusb firmware")
03310ea1e1e7 ("UBUNTU: Remove obsolete cxgb firmware")
064c4d3944e4 ("UBUNTU: Remove obsolete bnx2x firmware")
4ce08856dee0 ("UBUNTU: Remove obsolete ar9170 firmware")
c5a7aadccbfd ("UBUNTU: Remove obsolete ar7010 firmware")
f11a59536386 ("UBUNTU: Remove obsolete ath3k firmware")
2188b4baf819 ("UBUNTU: Remove obsolete 3com firmware")
0470cfcec635 ("UBUNT: Remove obsolete ath6k firmware")
e55ef4edc755 ("UBUNTU: Remove obsolete slicoss firmware")
0563995d173f ("UBUNTU: Remove obsolete ath9k firmware")
85ee46eb9136 ("UBUNTU: Remove obsolete ar3k firmware")
4f7cf7c3ecd1 ("UBUNTU: Remove obsolete bnx2x firmware files")
634d7ba9a08a ("UBUNTU: Remove obsolete iwlwifi ucode files")
ee2de66a5c8e ("UBUNTU: Drop obsolete cxgb3 firmware")
6a312e01f665 ("UBUNTU: Remove obsolete ueagle-atm firmware")

Removed #2 commits:

6364dccf3cf6 ("UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE")
0ee3db9fc288 ("UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE")
b5b56ccff00e ("UBUNTU: SAUCE: Remove obsolete files from WHENCE")
a627a307ae5d ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
0398c63ad4d5 ("UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE")
fe771637f2fb ("UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE")
67bde05fdf67 ("UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE")
bf1184377246 ("UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE")
554e29696398 ("UBUNTU: SAUCE: Remove obsolete 3com from WHENCE")
e89cc56af2a8 ("UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE")
19f93a469a30 ("UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE")
f7512d3ddbf2 ("UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE")
5374033d6cf9 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
7cb7df9d1b4c ("UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE")
c2f8f6087c71 ("UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE")
a3b4bfb6350c ("UBUNTU: SAUCE: Remove obsolete Computone from WHENCE")
0b25767b762e ("UBUNTU: SAUCE: Remove obsolete libertas from WHENCE")
9f505e5b38df ("UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE")
e134bb085a93 ("UBUNTU: SAUCE: Remove obsolete myricom from WHENCE")
c9d47ad1bb5c ("UBUNTU: SAUCE: Remove obsolete sxg from WHENCE")
69898586dda3 ("UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE")
e0c45aa236cb ("UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE")
c34fd0ed78aa ("UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE")
df2becc5ae36 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")

Removed #3 commits:

f25df0ab5d6d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
4685558a4306 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE"")
70de9f30507c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE"")
bfa02d2d78a9 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE"")
8602072bdc09 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete sxg from WHENCE"")
1664c8e4d112 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete myricom from WHENCE"")
ffe2b36ab183 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE"")
508a753ad4c6 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete libertas from WHENCE"")
5bc8c64aff3f ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete Computone from WHENCE"")
ca1e98863330 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE"")
1945d6ce8444 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE"")
e04f6f209c3c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
501fa54d2536 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE"")
afb50e6a581b ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE"")
44ddba93c32c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE"")
8436648da231 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete 3com from WHENCE"")
2f1d2d02682e ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE"")
a44e92ce40cd ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE"")
a32264fb18e1 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE"")
363cee77ee86 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE"")
e1a84a4030ed ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
9ea39053a338 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete files from WHENCE"")
c7cc420416ee ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE"")
87b90b7c960d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE"")

Removed #4 commits:

ccc1fe51b7a8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove amd64-microcode"")
b414629bc096 ("UBUNTU: SAUCE: Revert "UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices""")
e49792d86191 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
85e465fe789e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tr_smctr firmware"")
98a9f407adf8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ti-connectivity firmware"")
cd3774f837d1 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tda1004x firmware"")
8a3b516d3e19 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete sxg firmware"")
fe5d0c811d2b ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete myricom firmware"")
ef6bd3107d68 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete mwl8k firmware"")
c8efb5b021ef ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete libertas firmware"")
98d8fc5449ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete Computone firmware"")
fd9d93689df4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete dabusb firmware"")
65c6ff98909f ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete cxgb firmware"")
f13124a09e4d ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware"")
176127bd41dd ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar9170 firmware"")
158bb95bad45 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar7010 firmware"")
898ffa58b927 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath3k firmware"")
be2094113362 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete 3com firmware"")
cd64bbc67264 ("UBUNTU: SAUCE: Revert "UBUNT: Remove obsolete ath6k firmware"")
3748946211c8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete slicoss firmware"")
5ca659c4e7d8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath9k firmware"")
4810ffeb8be9 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar3k firmware"")
c460239b267e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
9f64056d66ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete iwlwifi ucode files"")
9446e4477c8c ("UBUNTU: SAUCE: Revert "UBUNTU: Drop obsolete cxgb3 firmware"")
eff4f433b3b4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ueagle-atm firmware"")

Signed-off-by: Juerg Haefliger <juergh@canonical.com>
jackpot51 pushed a commit that referenced this issue Apr 1, 2022
UBUNTU: [Documentation] Justification for removal of UBUNTU commits
acaf158 
This is an empty commit for documentation purposes only.

Historically, some old and unused firmware was removed by directly purging
the firmware files from the repo with UBUNTU commits or by reverting the
relevant upstream commits. Subsequent UBUNTU commits cleaned up the WHENCE
file and removed stale entries so that the check-whence.py checker is
happy.

Recent changes introduced the concept of listing firmware files, that
should not be packaged, in a separate file debian/remove-firmware.list.
These changes also included the reverting of the above mentioned commits
and the addition of the 'removed' firmware files to remove-firmware.list so
that the resulting package content doesn't change.

With that, we ended up with 5 commits per firmware removal set:
  1) The original firmware removal commit
  2) The subsequent WHENCE fixup
  3) The revert of #2
  4) The revert of #1
  5) The addition of the 'removed' firmware files to remove-firmware.list

This is not ideal since a) upstream files are modified (WHENCE) and deleted
for the sole purpose of not packaging them and b) because of that,
subsequent rebases to latest upstream could result in conflicts.

For these reasons, it was decided to alter the history of this branch and
remove commits #1 to #4 and only keep #5. Note that some of the #1 commits
unfortunately touched both upstream and UBUNTU files. Only the
modifications of upstream files was removed, the UBUNTU modifications
needed to be kept.

Both branch commits (before and after the rebase and removal of commits)
are tagged and it was verified, that the repo content at these tags is
identical (except for debian/changelog). More specifically, the 'before'
tag is:
  Ubuntu-20220217.git6342082c-0ubuntu2
and the 'after' tag is:
  Ubuntu-20220217.git6342082c-0ubuntu3

$ git diff --name-only Ubuntu-20220217.git6342082c-0ubuntu2 Ubuntu-20220217.git6342082c-0ubuntu3
debian/changelog

Removed #1 commits:

563bb48ed143 ("UBUNTU: Remove amd64-microcode")
251237583bdd ("UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices"")
513a97a03fba ("UBUNTU: Remove obsolete bnx2x firmware files")
935dc770957e ("UBUNTU: Remove obsolete tr_smctr firmware")
1be4f28f91fb ("UBUNTU: Remove obsolete ti-connectivity firmware")
3d183a325fec ("UBUNTU: Remove obsolete tda1004x firmware")
09e02976b05b ("UBUNTU: Remove obsolete sxg firmware")
9b6d6bbcbc18 ("UBUNTU: Remove obsolete myricom firmware")
bfa2ac04ade6 ("UBUNTU: Remove obsolete mwl8k firmware")
a46068ae4580 ("UBUNTU: Remove obsolete libertas firmware")
1faeeb10de57 ("UBUNTU: Remove obsolete Computone firmware")
22f2239919d9 ("UBUNTU: Remove obsolete dabusb firmware")
03310ea1e1e7 ("UBUNTU: Remove obsolete cxgb firmware")
064c4d3944e4 ("UBUNTU: Remove obsolete bnx2x firmware")
4ce08856dee0 ("UBUNTU: Remove obsolete ar9170 firmware")
c5a7aadccbfd ("UBUNTU: Remove obsolete ar7010 firmware")
f11a59536386 ("UBUNTU: Remove obsolete ath3k firmware")
2188b4baf819 ("UBUNTU: Remove obsolete 3com firmware")
0470cfcec635 ("UBUNT: Remove obsolete ath6k firmware")
e55ef4edc755 ("UBUNTU: Remove obsolete slicoss firmware")
0563995d173f ("UBUNTU: Remove obsolete ath9k firmware")
85ee46eb9136 ("UBUNTU: Remove obsolete ar3k firmware")
4f7cf7c3ecd1 ("UBUNTU: Remove obsolete bnx2x firmware files")
634d7ba9a08a ("UBUNTU: Remove obsolete iwlwifi ucode files")
ee2de66a5c8e ("UBUNTU: Drop obsolete cxgb3 firmware")
6a312e01f665 ("UBUNTU: Remove obsolete ueagle-atm firmware")

Removed #2 commits:

6364dccf3cf6 ("UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE")
0ee3db9fc288 ("UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE")
b5b56ccff00e ("UBUNTU: SAUCE: Remove obsolete files from WHENCE")
a627a307ae5d ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
0398c63ad4d5 ("UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE")
fe771637f2fb ("UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE")
67bde05fdf67 ("UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE")
bf1184377246 ("UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE")
554e29696398 ("UBUNTU: SAUCE: Remove obsolete 3com from WHENCE")
e89cc56af2a8 ("UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE")
19f93a469a30 ("UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE")
f7512d3ddbf2 ("UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE")
5374033d6cf9 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
7cb7df9d1b4c ("UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE")
c2f8f6087c71 ("UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE")
a3b4bfb6350c ("UBUNTU: SAUCE: Remove obsolete Computone from WHENCE")
0b25767b762e ("UBUNTU: SAUCE: Remove obsolete libertas from WHENCE")
9f505e5b38df ("UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE")
e134bb085a93 ("UBUNTU: SAUCE: Remove obsolete myricom from WHENCE")
c9d47ad1bb5c ("UBUNTU: SAUCE: Remove obsolete sxg from WHENCE")
69898586dda3 ("UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE")
e0c45aa236cb ("UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE")
c34fd0ed78aa ("UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE")
df2becc5ae36 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")

Removed #3 commits:

f25df0ab5d6d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
4685558a4306 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE"")
70de9f30507c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE"")
bfa02d2d78a9 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE"")
8602072bdc09 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete sxg from WHENCE"")
1664c8e4d112 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete myricom from WHENCE"")
ffe2b36ab183 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE"")
508a753ad4c6 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete libertas from WHENCE"")
5bc8c64aff3f ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete Computone from WHENCE"")
ca1e98863330 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE"")
1945d6ce8444 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE"")
e04f6f209c3c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
501fa54d2536 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE"")
afb50e6a581b ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE"")
44ddba93c32c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE"")
8436648da231 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete 3com from WHENCE"")
2f1d2d02682e ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE"")
a44e92ce40cd ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE"")
a32264fb18e1 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE"")
363cee77ee86 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE"")
e1a84a4030ed ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
9ea39053a338 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete files from WHENCE"")
c7cc420416ee ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE"")
87b90b7c960d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE"")

Removed #4 commits:

ccc1fe51b7a8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove amd64-microcode"")
b414629bc096 ("UBUNTU: SAUCE: Revert "UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices""")
e49792d86191 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
85e465fe789e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tr_smctr firmware"")
98a9f407adf8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ti-connectivity firmware"")
cd3774f837d1 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tda1004x firmware"")
8a3b516d3e19 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete sxg firmware"")
fe5d0c811d2b ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete myricom firmware"")
ef6bd3107d68 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete mwl8k firmware"")
c8efb5b021ef ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete libertas firmware"")
98d8fc5449ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete Computone firmware"")
fd9d93689df4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete dabusb firmware"")
65c6ff98909f ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete cxgb firmware"")
f13124a09e4d ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware"")
176127bd41dd ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar9170 firmware"")
158bb95bad45 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar7010 firmware"")
898ffa58b927 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath3k firmware"")
be2094113362 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete 3com firmware"")
cd64bbc67264 ("UBUNTU: SAUCE: Revert "UBUNT: Remove obsolete ath6k firmware"")
3748946211c8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete slicoss firmware"")
5ca659c4e7d8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath9k firmware"")
4810ffeb8be9 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar3k firmware"")
c460239b267e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
9f64056d66ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete iwlwifi ucode files"")
9446e4477c8c ("UBUNTU: SAUCE: Revert "UBUNTU: Drop obsolete cxgb3 firmware"")
eff4f433b3b4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ueagle-atm firmware"")

Signed-off-by: Juerg Haefliger <juergh@canonical.com>
jackpot51 pushed a commit that referenced this issue Sep 27, 2022
@juergh
UBUNTU: [Documentation] Justification for removal of UBUNTU commits
6d0774f 
This is an empty commit for documentation purposes only.

Historically, some old and unused firmware was removed by directly purging
the firmware files from the repo with UBUNTU commits or by reverting the
relevant upstream commits. Subsequent UBUNTU commits cleaned up the WHENCE
file and removed stale entries so that the check-whence.py checker is
happy.

Recent changes introduced the concept of listing firmware files, that
should not be packaged, in a separate file debian/remove-firmware.list.
These changes also included the reverting of the above mentioned commits
and the addition of the 'removed' firmware files to remove-firmware.list so
that the resulting package content doesn't change.

With that, we ended up with 5 commits per firmware removal set:
  1) The original firmware removal commit
  2) The subsequent WHENCE fixup
  3) The revert of #2
  4) The revert of #1
  5) The addition of the 'removed' firmware files to remove-firmware.list

This is not ideal since a) upstream files are modified (WHENCE) and deleted
for the sole purpose of not packaging them and b) because of that,
subsequent rebases to latest upstream could result in conflicts.

For these reasons, it was decided to alter the history of this branch and
remove commits #1 to #4 and only keep #5. Note that some of the #1 commits
unfortunately touched both upstream and UBUNTU files. Only the
modifications of upstream files was removed, the UBUNTU modifications
needed to be kept.

Both branch commits (before and after the rebase and removal of commits)
are tagged and it was verified, that the repo content at these tags is
identical (except for debian/changelog). More specifically, the 'before'
tag is:
  Ubuntu-20220217.git6342082c-0ubuntu2
and the 'after' tag is:
  Ubuntu-20220217.git6342082c-0ubuntu3

$ git diff --name-only Ubuntu-20220217.git6342082c-0ubuntu2 Ubuntu-20220217.git6342082c-0ubuntu3
debian/changelog

Removed #1 commits:

563bb48ed143 ("UBUNTU: Remove amd64-microcode")
251237583bdd ("UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices"")
513a97a03fba ("UBUNTU: Remove obsolete bnx2x firmware files")
935dc770957e ("UBUNTU: Remove obsolete tr_smctr firmware")
1be4f28f91fb ("UBUNTU: Remove obsolete ti-connectivity firmware")
3d183a325fec ("UBUNTU: Remove obsolete tda1004x firmware")
09e02976b05b ("UBUNTU: Remove obsolete sxg firmware")
9b6d6bbcbc18 ("UBUNTU: Remove obsolete myricom firmware")
bfa2ac04ade6 ("UBUNTU: Remove obsolete mwl8k firmware")
a46068ae4580 ("UBUNTU: Remove obsolete libertas firmware")
1faeeb10de57 ("UBUNTU: Remove obsolete Computone firmware")
22f2239919d9 ("UBUNTU: Remove obsolete dabusb firmware")
03310ea1e1e7 ("UBUNTU: Remove obsolete cxgb firmware")
064c4d3944e4 ("UBUNTU: Remove obsolete bnx2x firmware")
4ce08856dee0 ("UBUNTU: Remove obsolete ar9170 firmware")
c5a7aadccbfd ("UBUNTU: Remove obsolete ar7010 firmware")
f11a59536386 ("UBUNTU: Remove obsolete ath3k firmware")
2188b4baf819 ("UBUNTU: Remove obsolete 3com firmware")
0470cfcec635 ("UBUNT: Remove obsolete ath6k firmware")
e55ef4edc755 ("UBUNTU: Remove obsolete slicoss firmware")
0563995d173f ("UBUNTU: Remove obsolete ath9k firmware")
85ee46eb9136 ("UBUNTU: Remove obsolete ar3k firmware")
4f7cf7c3ecd1 ("UBUNTU: Remove obsolete bnx2x firmware files")
634d7ba9a08a ("UBUNTU: Remove obsolete iwlwifi ucode files")
ee2de66a5c8e ("UBUNTU: Drop obsolete cxgb3 firmware")
6a312e01f665 ("UBUNTU: Remove obsolete ueagle-atm firmware")

Removed #2 commits:

6364dccf3cf6 ("UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE")
0ee3db9fc288 ("UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE")
b5b56ccff00e ("UBUNTU: SAUCE: Remove obsolete files from WHENCE")
a627a307ae5d ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
0398c63ad4d5 ("UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE")
fe771637f2fb ("UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE")
67bde05fdf67 ("UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE")
bf1184377246 ("UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE")
554e29696398 ("UBUNTU: SAUCE: Remove obsolete 3com from WHENCE")
e89cc56af2a8 ("UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE")
19f93a469a30 ("UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE")
f7512d3ddbf2 ("UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE")
5374033d6cf9 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
7cb7df9d1b4c ("UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE")
c2f8f6087c71 ("UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE")
a3b4bfb6350c ("UBUNTU: SAUCE: Remove obsolete Computone from WHENCE")
0b25767b762e ("UBUNTU: SAUCE: Remove obsolete libertas from WHENCE")
9f505e5b38df ("UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE")
e134bb085a93 ("UBUNTU: SAUCE: Remove obsolete myricom from WHENCE")
c9d47ad1bb5c ("UBUNTU: SAUCE: Remove obsolete sxg from WHENCE")
69898586dda3 ("UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE")
e0c45aa236cb ("UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE")
c34fd0ed78aa ("UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE")
df2becc5ae36 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")

Removed #3 commits:

f25df0ab5d6d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
4685558a4306 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE"")
70de9f30507c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE"")
bfa02d2d78a9 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE"")
8602072bdc09 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete sxg from WHENCE"")
1664c8e4d112 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete myricom from WHENCE"")
ffe2b36ab183 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE"")
508a753ad4c6 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete libertas from WHENCE"")
5bc8c64aff3f ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete Computone from WHENCE"")
ca1e98863330 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE"")
1945d6ce8444 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE"")
e04f6f209c3c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
501fa54d2536 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE"")
afb50e6a581b ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE"")
44ddba93c32c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE"")
8436648da231 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete 3com from WHENCE"")
2f1d2d02682e ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE"")
a44e92ce40cd ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE"")
a32264fb18e1 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE"")
363cee77ee86 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE"")
e1a84a4030ed ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
9ea39053a338 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete files from WHENCE"")
c7cc420416ee ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE"")
87b90b7c960d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE"")

Removed #4 commits:

ccc1fe51b7a8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove amd64-microcode"")
b414629bc096 ("UBUNTU: SAUCE: Revert "UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices""")
e49792d86191 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
85e465fe789e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tr_smctr firmware"")
98a9f407adf8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ti-connectivity firmware"")
cd3774f837d1 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tda1004x firmware"")
8a3b516d3e19 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete sxg firmware"")
fe5d0c811d2b ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete myricom firmware"")
ef6bd3107d68 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete mwl8k firmware"")
c8efb5b021ef ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete libertas firmware"")
98d8fc5449ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete Computone firmware"")
fd9d93689df4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete dabusb firmware"")
65c6ff98909f ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete cxgb firmware"")
f13124a09e4d ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware"")
176127bd41dd ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar9170 firmware"")
158bb95bad45 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar7010 firmware"")
898ffa58b927 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath3k firmware"")
be2094113362 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete 3com firmware"")
cd64bbc67264 ("UBUNTU: SAUCE: Revert "UBUNT: Remove obsolete ath6k firmware"")
3748946211c8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete slicoss firmware"")
5ca659c4e7d8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath9k firmware"")
4810ffeb8be9 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar3k firmware"")
c460239b267e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
9f64056d66ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete iwlwifi ucode files"")
9446e4477c8c ("UBUNTU: SAUCE: Revert "UBUNTU: Drop obsolete cxgb3 firmware"")
eff4f433b3b4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ueagle-atm firmware"")

Signed-off-by: Juerg Haefliger <juergh@canonical.com>
13r0ck pushed a commit that referenced this issue Feb 3, 2023
@juergh
UBUNTU: [Documentation] Justification for removal of UBUNTU commits
133a415 
This is an empty commit for documentation purposes only.

Historically, some old and unused firmware was removed by directly purging
the firmware files from the repo with UBUNTU commits or by reverting the
relevant upstream commits. Subsequent UBUNTU commits cleaned up the WHENCE
file and removed stale entries so that the check-whence.py checker is
happy.

Recent changes introduced the concept of listing firmware files, that
should not be packaged, in a separate file debian/remove-firmware.list.
These changes also included the reverting of the above mentioned commits
and the addition of the 'removed' firmware files to remove-firmware.list so
that the resulting package content doesn't change.

With that, we ended up with 5 commits per firmware removal set:
  1) The original firmware removal commit
  2) The subsequent WHENCE fixup
  3) The revert of #2
  4) The revert of #1
  5) The addition of the 'removed' firmware files to remove-firmware.list

This is not ideal since a) upstream files are modified (WHENCE) and deleted
for the sole purpose of not packaging them and b) because of that,
subsequent rebases to latest upstream could result in conflicts.

For these reasons, it was decided to alter the history of this branch and
remove commits #1 to #4 and only keep #5. Note that some of the #1 commits
unfortunately touched both upstream and UBUNTU files. Only the
modifications of upstream files was removed, the UBUNTU modifications
needed to be kept.

Both branch commits (before and after the rebase and removal of commits)
are tagged and it was verified, that the repo content at these tags is
identical (except for debian/changelog). More specifically, the 'before'
tag is:
  Ubuntu-20220217.git6342082c-0ubuntu2
and the 'after' tag is:
  Ubuntu-20220217.git6342082c-0ubuntu3

$ git diff --name-only Ubuntu-20220217.git6342082c-0ubuntu2 Ubuntu-20220217.git6342082c-0ubuntu3
debian/changelog

Removed #1 commits:

563bb48ed143 ("UBUNTU: Remove amd64-microcode")
251237583bdd ("UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices"")
513a97a03fba ("UBUNTU: Remove obsolete bnx2x firmware files")
935dc770957e ("UBUNTU: Remove obsolete tr_smctr firmware")
1be4f28f91fb ("UBUNTU: Remove obsolete ti-connectivity firmware")
3d183a325fec ("UBUNTU: Remove obsolete tda1004x firmware")
09e02976b05b ("UBUNTU: Remove obsolete sxg firmware")
9b6d6bbcbc18 ("UBUNTU: Remove obsolete myricom firmware")
bfa2ac04ade6 ("UBUNTU: Remove obsolete mwl8k firmware")
a46068ae4580 ("UBUNTU: Remove obsolete libertas firmware")
1faeeb10de57 ("UBUNTU: Remove obsolete Computone firmware")
22f2239919d9 ("UBUNTU: Remove obsolete dabusb firmware")
03310ea1e1e7 ("UBUNTU: Remove obsolete cxgb firmware")
064c4d3944e4 ("UBUNTU: Remove obsolete bnx2x firmware")
4ce08856dee0 ("UBUNTU: Remove obsolete ar9170 firmware")
c5a7aadccbfd ("UBUNTU: Remove obsolete ar7010 firmware")
f11a59536386 ("UBUNTU: Remove obsolete ath3k firmware")
2188b4baf819 ("UBUNTU: Remove obsolete 3com firmware")
0470cfcec635 ("UBUNT: Remove obsolete ath6k firmware")
e55ef4edc755 ("UBUNTU: Remove obsolete slicoss firmware")
0563995d173f ("UBUNTU: Remove obsolete ath9k firmware")
85ee46eb9136 ("UBUNTU: Remove obsolete ar3k firmware")
4f7cf7c3ecd1 ("UBUNTU: Remove obsolete bnx2x firmware files")
634d7ba9a08a ("UBUNTU: Remove obsolete iwlwifi ucode files")
ee2de66a5c8e ("UBUNTU: Drop obsolete cxgb3 firmware")
6a312e01f665 ("UBUNTU: Remove obsolete ueagle-atm firmware")

Removed #2 commits:

6364dccf3cf6 ("UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE")
0ee3db9fc288 ("UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE")
b5b56ccff00e ("UBUNTU: SAUCE: Remove obsolete files from WHENCE")
a627a307ae5d ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
0398c63ad4d5 ("UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE")
fe771637f2fb ("UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE")
67bde05fdf67 ("UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE")
bf1184377246 ("UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE")
554e29696398 ("UBUNTU: SAUCE: Remove obsolete 3com from WHENCE")
e89cc56af2a8 ("UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE")
19f93a469a30 ("UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE")
f7512d3ddbf2 ("UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE")
5374033d6cf9 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
7cb7df9d1b4c ("UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE")
c2f8f6087c71 ("UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE")
a3b4bfb6350c ("UBUNTU: SAUCE: Remove obsolete Computone from WHENCE")
0b25767b762e ("UBUNTU: SAUCE: Remove obsolete libertas from WHENCE")
9f505e5b38df ("UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE")
e134bb085a93 ("UBUNTU: SAUCE: Remove obsolete myricom from WHENCE")
c9d47ad1bb5c ("UBUNTU: SAUCE: Remove obsolete sxg from WHENCE")
69898586dda3 ("UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE")
e0c45aa236cb ("UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE")
c34fd0ed78aa ("UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE")
df2becc5ae36 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")

Removed #3 commits:

f25df0ab5d6d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
4685558a4306 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE"")
70de9f30507c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE"")
bfa02d2d78a9 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE"")
8602072bdc09 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete sxg from WHENCE"")
1664c8e4d112 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete myricom from WHENCE"")
ffe2b36ab183 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE"")
508a753ad4c6 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete libertas from WHENCE"")
5bc8c64aff3f ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete Computone from WHENCE"")
ca1e98863330 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE"")
1945d6ce8444 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE"")
e04f6f209c3c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
501fa54d2536 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE"")
afb50e6a581b ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE"")
44ddba93c32c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE"")
8436648da231 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete 3com from WHENCE"")
2f1d2d02682e ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE"")
a44e92ce40cd ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE"")
a32264fb18e1 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE"")
363cee77ee86 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE"")
e1a84a4030ed ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
9ea39053a338 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete files from WHENCE"")
c7cc420416ee ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE"")
87b90b7c960d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE"")

Removed #4 commits:

ccc1fe51b7a8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove amd64-microcode"")
b414629bc096 ("UBUNTU: SAUCE: Revert "UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices""")
e49792d86191 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
85e465fe789e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tr_smctr firmware"")
98a9f407adf8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ti-connectivity firmware"")
cd3774f837d1 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tda1004x firmware"")
8a3b516d3e19 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete sxg firmware"")
fe5d0c811d2b ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete myricom firmware"")
ef6bd3107d68 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete mwl8k firmware"")
c8efb5b021ef ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete libertas firmware"")
98d8fc5449ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete Computone firmware"")
fd9d93689df4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete dabusb firmware"")
65c6ff98909f ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete cxgb firmware"")
f13124a09e4d ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware"")
176127bd41dd ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar9170 firmware"")
158bb95bad45 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar7010 firmware"")
898ffa58b927 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath3k firmware"")
be2094113362 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete 3com firmware"")
cd64bbc67264 ("UBUNTU: SAUCE: Revert "UBUNT: Remove obsolete ath6k firmware"")
3748946211c8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete slicoss firmware"")
5ca659c4e7d8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath9k firmware"")
4810ffeb8be9 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar3k firmware"")
c460239b267e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
9f64056d66ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete iwlwifi ucode files"")
9446e4477c8c ("UBUNTU: SAUCE: Revert "UBUNTU: Drop obsolete cxgb3 firmware"")
eff4f433b3b4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ueagle-atm firmware"")

Signed-off-by: Juerg Haefliger <juergh@canonical.com>
13r0ck pushed a commit that referenced this issue Feb 3, 2023
@13r0ck
UBUNTU: [Documentation] Justification for removal of UBUNTU commits
341aa84 
This is an empty commit for documentation purposes only.

Historically, some old and unused firmware was removed by directly purging
the firmware files from the repo with UBUNTU commits or by reverting the
relevant upstream commits. Subsequent UBUNTU commits cleaned up the WHENCE
file and removed stale entries so that the check-whence.py checker is
happy.

Recent changes introduced the concept of listing firmware files, that
should not be packaged, in a separate file debian/remove-firmware.list.
These changes also included the reverting of the above mentioned commits
and the addition of the 'removed' firmware files to remove-firmware.list so
that the resulting package content doesn't change.

With that, we ended up with 5 commits per firmware removal set:
  1) The original firmware removal commit
  2) The subsequent WHENCE fixup
  3) The revert of #2
  4) The revert of #1
  5) The addition of the 'removed' firmware files to remove-firmware.list

This is not ideal since a) upstream files are modified (WHENCE) and deleted
for the sole purpose of not packaging them and b) because of that,
subsequent rebases to latest upstream could result in conflicts.

For these reasons, it was decided to alter the history of this branch and
remove commits #1 to #4 and only keep #5. Note that some of the #1 commits
unfortunately touched both upstream and UBUNTU files. Only the
modifications of upstream files was removed, the UBUNTU modifications
needed to be kept.

Both branch commits (before and after the rebase and removal of commits)
are tagged and it was verified, that the repo content at these tags is
identical (except for debian/changelog). More specifically, the 'before'
tag is:
  Ubuntu-20220217.git6342082c-0ubuntu2
and the 'after' tag is:
  Ubuntu-20220217.git6342082c-0ubuntu3

$ git diff --name-only Ubuntu-20220217.git6342082c-0ubuntu2 Ubuntu-20220217.git6342082c-0ubuntu3
debian/changelog

Removed #1 commits:

563bb48ed143 ("UBUNTU: Remove amd64-microcode")
251237583bdd ("UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices"")
513a97a03fba ("UBUNTU: Remove obsolete bnx2x firmware files")
935dc770957e ("UBUNTU: Remove obsolete tr_smctr firmware")
1be4f28f91fb ("UBUNTU: Remove obsolete ti-connectivity firmware")
3d183a325fec ("UBUNTU: Remove obsolete tda1004x firmware")
09e02976b05b ("UBUNTU: Remove obsolete sxg firmware")
9b6d6bbcbc18 ("UBUNTU: Remove obsolete myricom firmware")
bfa2ac04ade6 ("UBUNTU: Remove obsolete mwl8k firmware")
a46068ae4580 ("UBUNTU: Remove obsolete libertas firmware")
1faeeb10de57 ("UBUNTU: Remove obsolete Computone firmware")
22f2239919d9 ("UBUNTU: Remove obsolete dabusb firmware")
03310ea1e1e7 ("UBUNTU: Remove obsolete cxgb firmware")
064c4d3944e4 ("UBUNTU: Remove obsolete bnx2x firmware")
4ce08856dee0 ("UBUNTU: Remove obsolete ar9170 firmware")
c5a7aadccbfd ("UBUNTU: Remove obsolete ar7010 firmware")
f11a59536386 ("UBUNTU: Remove obsolete ath3k firmware")
2188b4baf819 ("UBUNTU: Remove obsolete 3com firmware")
0470cfcec635 ("UBUNT: Remove obsolete ath6k firmware")
e55ef4edc755 ("UBUNTU: Remove obsolete slicoss firmware")
0563995d173f ("UBUNTU: Remove obsolete ath9k firmware")
85ee46eb9136 ("UBUNTU: Remove obsolete ar3k firmware")
4f7cf7c3ecd1 ("UBUNTU: Remove obsolete bnx2x firmware files")
634d7ba9a08a ("UBUNTU: Remove obsolete iwlwifi ucode files")
ee2de66a5c8e ("UBUNTU: Drop obsolete cxgb3 firmware")
6a312e01f665 ("UBUNTU: Remove obsolete ueagle-atm firmware")

Removed #2 commits:

6364dccf3cf6 ("UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE")
0ee3db9fc288 ("UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE")
b5b56ccff00e ("UBUNTU: SAUCE: Remove obsolete files from WHENCE")
a627a307ae5d ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
0398c63ad4d5 ("UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE")
fe771637f2fb ("UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE")
67bde05fdf67 ("UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE")
bf1184377246 ("UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE")
554e29696398 ("UBUNTU: SAUCE: Remove obsolete 3com from WHENCE")
e89cc56af2a8 ("UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE")
19f93a469a30 ("UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE")
f7512d3ddbf2 ("UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE")
5374033d6cf9 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
7cb7df9d1b4c ("UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE")
c2f8f6087c71 ("UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE")
a3b4bfb6350c ("UBUNTU: SAUCE: Remove obsolete Computone from WHENCE")
0b25767b762e ("UBUNTU: SAUCE: Remove obsolete libertas from WHENCE")
9f505e5b38df ("UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE")
e134bb085a93 ("UBUNTU: SAUCE: Remove obsolete myricom from WHENCE")
c9d47ad1bb5c ("UBUNTU: SAUCE: Remove obsolete sxg from WHENCE")
69898586dda3 ("UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE")
e0c45aa236cb ("UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE")
c34fd0ed78aa ("UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE")
df2becc5ae36 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")

Removed #3 commits:

f25df0ab5d6d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
4685558a4306 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE"")
70de9f30507c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE"")
bfa02d2d78a9 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE"")
8602072bdc09 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete sxg from WHENCE"")
1664c8e4d112 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete myricom from WHENCE"")
ffe2b36ab183 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE"")
508a753ad4c6 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete libertas from WHENCE"")
5bc8c64aff3f ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete Computone from WHENCE"")
ca1e98863330 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE"")
1945d6ce8444 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE"")
e04f6f209c3c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
501fa54d2536 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE"")
afb50e6a581b ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE"")
44ddba93c32c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE"")
8436648da231 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete 3com from WHENCE"")
2f1d2d02682e ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE"")
a44e92ce40cd ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE"")
a32264fb18e1 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE"")
363cee77ee86 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE"")
e1a84a4030ed ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
9ea39053a338 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete files from WHENCE"")
c7cc420416ee ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE"")
87b90b7c960d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE"")

Removed #4 commits:

ccc1fe51b7a8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove amd64-microcode"")
b414629bc096 ("UBUNTU: SAUCE: Revert "UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices""")
e49792d86191 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
85e465fe789e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tr_smctr firmware"")
98a9f407adf8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ti-connectivity firmware"")
cd3774f837d1 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tda1004x firmware"")
8a3b516d3e19 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete sxg firmware"")
fe5d0c811d2b ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete myricom firmware"")
ef6bd3107d68 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete mwl8k firmware"")
c8efb5b021ef ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete libertas firmware"")
98d8fc5449ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete Computone firmware"")
fd9d93689df4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete dabusb firmware"")
65c6ff98909f ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete cxgb firmware"")
f13124a09e4d ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware"")
176127bd41dd ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar9170 firmware"")
158bb95bad45 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar7010 firmware"")
898ffa58b927 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath3k firmware"")
be2094113362 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete 3com firmware"")
cd64bbc67264 ("UBUNTU: SAUCE: Revert "UBUNT: Remove obsolete ath6k firmware"")
3748946211c8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete slicoss firmware"")
5ca659c4e7d8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath9k firmware"")
4810ffeb8be9 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar3k firmware"")
c460239b267e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
9f64056d66ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete iwlwifi ucode files"")
9446e4477c8c ("UBUNTU: SAUCE: Revert "UBUNTU: Drop obsolete cxgb3 firmware"")
eff4f433b3b4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ueagle-atm firmware"")

Signed-off-by: Juerg Haefliger <juergh@canonical.com>
13r0ck pushed a commit that referenced this issue Feb 23, 2023
@juergh
UBUNTU: [Documentation] Justification for removal of UBUNTU commits
bc7ae91 
This is an empty commit for documentation purposes only.

Historically, some old and unused firmware was removed by directly purging
the firmware files from the repo with UBUNTU commits or by reverting the
relevant upstream commits. Subsequent UBUNTU commits cleaned up the WHENCE
file and removed stale entries so that the check-whence.py checker is
happy.

Recent changes introduced the concept of listing firmware files, that
should not be packaged, in a separate file debian/remove-firmware.list.
These changes also included the reverting of the above mentioned commits
and the addition of the 'removed' firmware files to remove-firmware.list so
that the resulting package content doesn't change.

With that, we ended up with 5 commits per firmware removal set:
  1) The original firmware removal commit
  2) The subsequent WHENCE fixup
  3) The revert of #2
  4) The revert of #1
  5) The addition of the 'removed' firmware files to remove-firmware.list

This is not ideal since a) upstream files are modified (WHENCE) and deleted
for the sole purpose of not packaging them and b) because of that,
subsequent rebases to latest upstream could result in conflicts.

For these reasons, it was decided to alter the history of this branch and
remove commits #1 to #4 and only keep #5. Note that some of the #1 commits
unfortunately touched both upstream and UBUNTU files. Only the
modifications of upstream files was removed, the UBUNTU modifications
needed to be kept.

Both branch commits (before and after the rebase and removal of commits)
are tagged and it was verified, that the repo content at these tags is
identical (except for debian/changelog). More specifically, the 'before'
tag is:
  Ubuntu-20220217.git6342082c-0ubuntu2
and the 'after' tag is:
  Ubuntu-20220217.git6342082c-0ubuntu3

$ git diff --name-only Ubuntu-20220217.git6342082c-0ubuntu2 Ubuntu-20220217.git6342082c-0ubuntu3
debian/changelog

Removed #1 commits:

563bb48ed143 ("UBUNTU: Remove amd64-microcode")
251237583bdd ("UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices"")
513a97a03fba ("UBUNTU: Remove obsolete bnx2x firmware files")
935dc770957e ("UBUNTU: Remove obsolete tr_smctr firmware")
1be4f28f91fb ("UBUNTU: Remove obsolete ti-connectivity firmware")
3d183a325fec ("UBUNTU: Remove obsolete tda1004x firmware")
09e02976b05b ("UBUNTU: Remove obsolete sxg firmware")
9b6d6bbcbc18 ("UBUNTU: Remove obsolete myricom firmware")
bfa2ac04ade6 ("UBUNTU: Remove obsolete mwl8k firmware")
a46068ae4580 ("UBUNTU: Remove obsolete libertas firmware")
1faeeb10de57 ("UBUNTU: Remove obsolete Computone firmware")
22f2239919d9 ("UBUNTU: Remove obsolete dabusb firmware")
03310ea1e1e7 ("UBUNTU: Remove obsolete cxgb firmware")
064c4d3944e4 ("UBUNTU: Remove obsolete bnx2x firmware")
4ce08856dee0 ("UBUNTU: Remove obsolete ar9170 firmware")
c5a7aadccbfd ("UBUNTU: Remove obsolete ar7010 firmware")
f11a59536386 ("UBUNTU: Remove obsolete ath3k firmware")
2188b4baf819 ("UBUNTU: Remove obsolete 3com firmware")
0470cfcec635 ("UBUNT: Remove obsolete ath6k firmware")
e55ef4edc755 ("UBUNTU: Remove obsolete slicoss firmware")
0563995d173f ("UBUNTU: Remove obsolete ath9k firmware")
85ee46eb9136 ("UBUNTU: Remove obsolete ar3k firmware")
4f7cf7c3ecd1 ("UBUNTU: Remove obsolete bnx2x firmware files")
634d7ba9a08a ("UBUNTU: Remove obsolete iwlwifi ucode files")
ee2de66a5c8e ("UBUNTU: Drop obsolete cxgb3 firmware")
6a312e01f665 ("UBUNTU: Remove obsolete ueagle-atm firmware")

Removed #2 commits:

6364dccf3cf6 ("UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE")
0ee3db9fc288 ("UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE")
b5b56ccff00e ("UBUNTU: SAUCE: Remove obsolete files from WHENCE")
a627a307ae5d ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
0398c63ad4d5 ("UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE")
fe771637f2fb ("UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE")
67bde05fdf67 ("UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE")
bf1184377246 ("UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE")
554e29696398 ("UBUNTU: SAUCE: Remove obsolete 3com from WHENCE")
e89cc56af2a8 ("UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE")
19f93a469a30 ("UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE")
f7512d3ddbf2 ("UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE")
5374033d6cf9 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
7cb7df9d1b4c ("UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE")
c2f8f6087c71 ("UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE")
a3b4bfb6350c ("UBUNTU: SAUCE: Remove obsolete Computone from WHENCE")
0b25767b762e ("UBUNTU: SAUCE: Remove obsolete libertas from WHENCE")
9f505e5b38df ("UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE")
e134bb085a93 ("UBUNTU: SAUCE: Remove obsolete myricom from WHENCE")
c9d47ad1bb5c ("UBUNTU: SAUCE: Remove obsolete sxg from WHENCE")
69898586dda3 ("UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE")
e0c45aa236cb ("UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE")
c34fd0ed78aa ("UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE")
df2becc5ae36 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")

Removed #3 commits:

f25df0ab5d6d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
4685558a4306 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE"")
70de9f30507c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE"")
bfa02d2d78a9 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE"")
8602072bdc09 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete sxg from WHENCE"")
1664c8e4d112 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete myricom from WHENCE"")
ffe2b36ab183 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE"")
508a753ad4c6 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete libertas from WHENCE"")
5bc8c64aff3f ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete Computone from WHENCE"")
ca1e98863330 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE"")
1945d6ce8444 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE"")
e04f6f209c3c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
501fa54d2536 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE"")
afb50e6a581b ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE"")
44ddba93c32c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE"")
8436648da231 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete 3com from WHENCE"")
2f1d2d02682e ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE"")
a44e92ce40cd ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE"")
a32264fb18e1 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE"")
363cee77ee86 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE"")
e1a84a4030ed ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
9ea39053a338 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete files from WHENCE"")
c7cc420416ee ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE"")
87b90b7c960d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE"")

Removed #4 commits:

ccc1fe51b7a8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove amd64-microcode"")
b414629bc096 ("UBUNTU: SAUCE: Revert "UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices""")
e49792d86191 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
85e465fe789e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tr_smctr firmware"")
98a9f407adf8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ti-connectivity firmware"")
cd3774f837d1 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tda1004x firmware"")
8a3b516d3e19 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete sxg firmware"")
fe5d0c811d2b ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete myricom firmware"")
ef6bd3107d68 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete mwl8k firmware"")
c8efb5b021ef ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete libertas firmware"")
98d8fc5449ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete Computone firmware"")
fd9d93689df4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete dabusb firmware"")
65c6ff98909f ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete cxgb firmware"")
f13124a09e4d ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware"")
176127bd41dd ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar9170 firmware"")
158bb95bad45 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar7010 firmware"")
898ffa58b927 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath3k firmware"")
be2094113362 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete 3com firmware"")
cd64bbc67264 ("UBUNTU: SAUCE: Revert "UBUNT: Remove obsolete ath6k firmware"")
3748946211c8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete slicoss firmware"")
5ca659c4e7d8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath9k firmware"")
4810ffeb8be9 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar3k firmware"")
c460239b267e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
9f64056d66ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete iwlwifi ucode files"")
9446e4477c8c ("UBUNTU: SAUCE: Revert "UBUNTU: Drop obsolete cxgb3 firmware"")
eff4f433b3b4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ueagle-atm firmware"")

Signed-off-by: Juerg Haefliger <juergh@canonical.com>
mmstick pushed a commit that referenced this issue Jul 3, 2023
@juergh
UBUNTU: [Documentation] Justification for removal of UBUNTU commits
caeaaf8 
This is an empty commit for documentation purposes only.

Historically, some old and unused firmware was removed by directly purging
the firmware files from the repo with UBUNTU commits or by reverting the
relevant upstream commits. Subsequent UBUNTU commits cleaned up the WHENCE
file and removed stale entries so that the check-whence.py checker is
happy.

Recent changes introduced the concept of listing firmware files, that
should not be packaged, in a separate file debian/remove-firmware.list.
These changes also included the reverting of the above mentioned commits
and the addition of the 'removed' firmware files to remove-firmware.list so
that the resulting package content doesn't change.

With that, we ended up with 5 commits per firmware removal set:
  1) The original firmware removal commit
  2) The subsequent WHENCE fixup
  3) The revert of #2
  4) The revert of #1
  5) The addition of the 'removed' firmware files to remove-firmware.list

This is not ideal since a) upstream files are modified (WHENCE) and deleted
for the sole purpose of not packaging them and b) because of that,
subsequent rebases to latest upstream could result in conflicts.

For these reasons, it was decided to alter the history of this branch and
remove commits #1 to #4 and only keep #5. Note that some of the #1 commits
unfortunately touched both upstream and UBUNTU files. Only the
modifications of upstream files was removed, the UBUNTU modifications
needed to be kept.

Both branch commits (before and after the rebase and removal of commits)
are tagged and it was verified, that the repo content at these tags is
identical (except for debian/changelog). More specifically, the 'before'
tag is:
  Ubuntu-20220217.git6342082c-0ubuntu2
and the 'after' tag is:
  Ubuntu-20220217.git6342082c-0ubuntu3

$ git diff --name-only Ubuntu-20220217.git6342082c-0ubuntu2 Ubuntu-20220217.git6342082c-0ubuntu3
debian/changelog

Removed #1 commits:

563bb48ed143 ("UBUNTU: Remove amd64-microcode")
251237583bdd ("UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices"")
513a97a03fba ("UBUNTU: Remove obsolete bnx2x firmware files")
935dc770957e ("UBUNTU: Remove obsolete tr_smctr firmware")
1be4f28f91fb ("UBUNTU: Remove obsolete ti-connectivity firmware")
3d183a325fec ("UBUNTU: Remove obsolete tda1004x firmware")
09e02976b05b ("UBUNTU: Remove obsolete sxg firmware")
9b6d6bbcbc18 ("UBUNTU: Remove obsolete myricom firmware")
bfa2ac04ade6 ("UBUNTU: Remove obsolete mwl8k firmware")
a46068ae4580 ("UBUNTU: Remove obsolete libertas firmware")
1faeeb10de57 ("UBUNTU: Remove obsolete Computone firmware")
22f2239919d9 ("UBUNTU: Remove obsolete dabusb firmware")
03310ea1e1e7 ("UBUNTU: Remove obsolete cxgb firmware")
064c4d3944e4 ("UBUNTU: Remove obsolete bnx2x firmware")
4ce08856dee0 ("UBUNTU: Remove obsolete ar9170 firmware")
c5a7aadccbfd ("UBUNTU: Remove obsolete ar7010 firmware")
f11a59536386 ("UBUNTU: Remove obsolete ath3k firmware")
2188b4baf819 ("UBUNTU: Remove obsolete 3com firmware")
0470cfcec635 ("UBUNT: Remove obsolete ath6k firmware")
e55ef4edc755 ("UBUNTU: Remove obsolete slicoss firmware")
0563995d173f ("UBUNTU: Remove obsolete ath9k firmware")
85ee46eb9136 ("UBUNTU: Remove obsolete ar3k firmware")
4f7cf7c3ecd1 ("UBUNTU: Remove obsolete bnx2x firmware files")
634d7ba9a08a ("UBUNTU: Remove obsolete iwlwifi ucode files")
ee2de66a5c8e ("UBUNTU: Drop obsolete cxgb3 firmware")
6a312e01f665 ("UBUNTU: Remove obsolete ueagle-atm firmware")

Removed #2 commits:

6364dccf3cf6 ("UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE")
0ee3db9fc288 ("UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE")
b5b56ccff00e ("UBUNTU: SAUCE: Remove obsolete files from WHENCE")
a627a307ae5d ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
0398c63ad4d5 ("UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE")
fe771637f2fb ("UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE")
67bde05fdf67 ("UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE")
bf1184377246 ("UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE")
554e29696398 ("UBUNTU: SAUCE: Remove obsolete 3com from WHENCE")
e89cc56af2a8 ("UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE")
19f93a469a30 ("UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE")
f7512d3ddbf2 ("UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE")
5374033d6cf9 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
7cb7df9d1b4c ("UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE")
c2f8f6087c71 ("UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE")
a3b4bfb6350c ("UBUNTU: SAUCE: Remove obsolete Computone from WHENCE")
0b25767b762e ("UBUNTU: SAUCE: Remove obsolete libertas from WHENCE")
9f505e5b38df ("UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE")
e134bb085a93 ("UBUNTU: SAUCE: Remove obsolete myricom from WHENCE")
c9d47ad1bb5c ("UBUNTU: SAUCE: Remove obsolete sxg from WHENCE")
69898586dda3 ("UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE")
e0c45aa236cb ("UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE")
c34fd0ed78aa ("UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE")
df2becc5ae36 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")

Removed #3 commits:

f25df0ab5d6d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
4685558a4306 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE"")
70de9f30507c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE"")
bfa02d2d78a9 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE"")
8602072bdc09 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete sxg from WHENCE"")
1664c8e4d112 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete myricom from WHENCE"")
ffe2b36ab183 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE"")
508a753ad4c6 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete libertas from WHENCE"")
5bc8c64aff3f ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete Computone from WHENCE"")
ca1e98863330 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE"")
1945d6ce8444 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE"")
e04f6f209c3c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
501fa54d2536 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE"")
afb50e6a581b ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE"")
44ddba93c32c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE"")
8436648da231 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete 3com from WHENCE"")
2f1d2d02682e ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE"")
a44e92ce40cd ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE"")
a32264fb18e1 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE"")
363cee77ee86 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE"")
e1a84a4030ed ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
9ea39053a338 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete files from WHENCE"")
c7cc420416ee ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE"")
87b90b7c960d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE"")

Removed #4 commits:

ccc1fe51b7a8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove amd64-microcode"")
b414629bc096 ("UBUNTU: SAUCE: Revert "UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices""")
e49792d86191 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
85e465fe789e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tr_smctr firmware"")
98a9f407adf8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ti-connectivity firmware"")
cd3774f837d1 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tda1004x firmware"")
8a3b516d3e19 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete sxg firmware"")
fe5d0c811d2b ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete myricom firmware"")
ef6bd3107d68 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete mwl8k firmware"")
c8efb5b021ef ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete libertas firmware"")
98d8fc5449ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete Computone firmware"")
fd9d93689df4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete dabusb firmware"")
65c6ff98909f ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete cxgb firmware"")
f13124a09e4d ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware"")
176127bd41dd ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar9170 firmware"")
158bb95bad45 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar7010 firmware"")
898ffa58b927 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath3k firmware"")
be2094113362 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete 3com firmware"")
cd64bbc67264 ("UBUNTU: SAUCE: Revert "UBUNT: Remove obsolete ath6k firmware"")
3748946211c8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete slicoss firmware"")
5ca659c4e7d8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath9k firmware"")
4810ffeb8be9 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar3k firmware"")
c460239b267e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
9f64056d66ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete iwlwifi ucode files"")
9446e4477c8c ("UBUNTU: SAUCE: Revert "UBUNTU: Drop obsolete cxgb3 firmware"")
eff4f433b3b4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ueagle-atm firmware"")

Signed-off-by: Juerg Haefliger <juergh@canonical.com>
mmstick pushed a commit that referenced this issue Aug 9, 2023
@juergh
UBUNTU: [Documentation] Justification for removal of UBUNTU commits
b72fb48 
This is an empty commit for documentation purposes only.

Historically, some old and unused firmware was removed by directly purging
the firmware files from the repo with UBUNTU commits or by reverting the
relevant upstream commits. Subsequent UBUNTU commits cleaned up the WHENCE
file and removed stale entries so that the check-whence.py checker is
happy.

Recent changes introduced the concept of listing firmware files, that
should not be packaged, in a separate file debian/remove-firmware.list.
These changes also included the reverting of the above mentioned commits
and the addition of the 'removed' firmware files to remove-firmware.list so
that the resulting package content doesn't change.

With that, we ended up with 5 commits per firmware removal set:
  1) The original firmware removal commit
  2) The subsequent WHENCE fixup
  3) The revert of #2
  4) The revert of #1
  5) The addition of the 'removed' firmware files to remove-firmware.list

This is not ideal since a) upstream files are modified (WHENCE) and deleted
for the sole purpose of not packaging them and b) because of that,
subsequent rebases to latest upstream could result in conflicts.

For these reasons, it was decided to alter the history of this branch and
remove commits #1 to #4 and only keep #5. Note that some of the #1 commits
unfortunately touched both upstream and UBUNTU files. Only the
modifications of upstream files was removed, the UBUNTU modifications
needed to be kept.

Both branch commits (before and after the rebase and removal of commits)
are tagged and it was verified, that the repo content at these tags is
identical (except for debian/changelog). More specifically, the 'before'
tag is:
  Ubuntu-20220217.git6342082c-0ubuntu2
and the 'after' tag is:
  Ubuntu-20220217.git6342082c-0ubuntu3

$ git diff --name-only Ubuntu-20220217.git6342082c-0ubuntu2 Ubuntu-20220217.git6342082c-0ubuntu3
debian/changelog

Removed #1 commits:

563bb48ed143 ("UBUNTU: Remove amd64-microcode")
251237583bdd ("UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices"")
513a97a03fba ("UBUNTU: Remove obsolete bnx2x firmware files")
935dc770957e ("UBUNTU: Remove obsolete tr_smctr firmware")
1be4f28f91fb ("UBUNTU: Remove obsolete ti-connectivity firmware")
3d183a325fec ("UBUNTU: Remove obsolete tda1004x firmware")
09e02976b05b ("UBUNTU: Remove obsolete sxg firmware")
9b6d6bbcbc18 ("UBUNTU: Remove obsolete myricom firmware")
bfa2ac04ade6 ("UBUNTU: Remove obsolete mwl8k firmware")
a46068ae4580 ("UBUNTU: Remove obsolete libertas firmware")
1faeeb10de57 ("UBUNTU: Remove obsolete Computone firmware")
22f2239919d9 ("UBUNTU: Remove obsolete dabusb firmware")
03310ea1e1e7 ("UBUNTU: Remove obsolete cxgb firmware")
064c4d3944e4 ("UBUNTU: Remove obsolete bnx2x firmware")
4ce08856dee0 ("UBUNTU: Remove obsolete ar9170 firmware")
c5a7aadccbfd ("UBUNTU: Remove obsolete ar7010 firmware")
f11a59536386 ("UBUNTU: Remove obsolete ath3k firmware")
2188b4baf819 ("UBUNTU: Remove obsolete 3com firmware")
0470cfcec635 ("UBUNT: Remove obsolete ath6k firmware")
e55ef4edc755 ("UBUNTU: Remove obsolete slicoss firmware")
0563995d173f ("UBUNTU: Remove obsolete ath9k firmware")
85ee46eb9136 ("UBUNTU: Remove obsolete ar3k firmware")
4f7cf7c3ecd1 ("UBUNTU: Remove obsolete bnx2x firmware files")
634d7ba9a08a ("UBUNTU: Remove obsolete iwlwifi ucode files")
ee2de66a5c8e ("UBUNTU: Drop obsolete cxgb3 firmware")
6a312e01f665 ("UBUNTU: Remove obsolete ueagle-atm firmware")

Removed #2 commits:

6364dccf3cf6 ("UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE")
0ee3db9fc288 ("UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE")
b5b56ccff00e ("UBUNTU: SAUCE: Remove obsolete files from WHENCE")
a627a307ae5d ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
0398c63ad4d5 ("UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE")
fe771637f2fb ("UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE")
67bde05fdf67 ("UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE")
bf1184377246 ("UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE")
554e29696398 ("UBUNTU: SAUCE: Remove obsolete 3com from WHENCE")
e89cc56af2a8 ("UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE")
19f93a469a30 ("UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE")
f7512d3ddbf2 ("UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE")
5374033d6cf9 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
7cb7df9d1b4c ("UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE")
c2f8f6087c71 ("UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE")
a3b4bfb6350c ("UBUNTU: SAUCE: Remove obsolete Computone from WHENCE")
0b25767b762e ("UBUNTU: SAUCE: Remove obsolete libertas from WHENCE")
9f505e5b38df ("UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE")
e134bb085a93 ("UBUNTU: SAUCE: Remove obsolete myricom from WHENCE")
c9d47ad1bb5c ("UBUNTU: SAUCE: Remove obsolete sxg from WHENCE")
69898586dda3 ("UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE")
e0c45aa236cb ("UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE")
c34fd0ed78aa ("UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE")
df2becc5ae36 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")

Removed #3 commits:

f25df0ab5d6d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
4685558a4306 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE"")
70de9f30507c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE"")
bfa02d2d78a9 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE"")
8602072bdc09 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete sxg from WHENCE"")
1664c8e4d112 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete myricom from WHENCE"")
ffe2b36ab183 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE"")
508a753ad4c6 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete libertas from WHENCE"")
5bc8c64aff3f ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete Computone from WHENCE"")
ca1e98863330 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE"")
1945d6ce8444 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE"")
e04f6f209c3c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
501fa54d2536 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE"")
afb50e6a581b ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE"")
44ddba93c32c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE"")
8436648da231 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete 3com from WHENCE"")
2f1d2d02682e ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE"")
a44e92ce40cd ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE"")
a32264fb18e1 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE"")
363cee77ee86 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE"")
e1a84a4030ed ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
9ea39053a338 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete files from WHENCE"")
c7cc420416ee ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE"")
87b90b7c960d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE"")

Removed #4 commits:

ccc1fe51b7a8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove amd64-microcode"")
b414629bc096 ("UBUNTU: SAUCE: Revert "UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices""")
e49792d86191 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
85e465fe789e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tr_smctr firmware"")
98a9f407adf8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ti-connectivity firmware"")
cd3774f837d1 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tda1004x firmware"")
8a3b516d3e19 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete sxg firmware"")
fe5d0c811d2b ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete myricom firmware"")
ef6bd3107d68 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete mwl8k firmware"")
c8efb5b021ef ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete libertas firmware"")
98d8fc5449ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete Computone firmware"")
fd9d93689df4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete dabusb firmware"")
65c6ff98909f ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete cxgb firmware"")
f13124a09e4d ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware"")
176127bd41dd ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar9170 firmware"")
158bb95bad45 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar7010 firmware"")
898ffa58b927 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath3k firmware"")
be2094113362 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete 3com firmware"")
cd64bbc67264 ("UBUNTU: SAUCE: Revert "UBUNT: Remove obsolete ath6k firmware"")
3748946211c8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete slicoss firmware"")
5ca659c4e7d8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath9k firmware"")
4810ffeb8be9 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar3k firmware"")
c460239b267e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
9f64056d66ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete iwlwifi ucode files"")
9446e4477c8c ("UBUNTU: SAUCE: Revert "UBUNTU: Drop obsolete cxgb3 firmware"")
eff4f433b3b4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ueagle-atm firmware"")

Signed-off-by: Juerg Haefliger <juergh@canonical.com>
mmstick pushed a commit that referenced this issue Aug 22, 2023
@juergh
UBUNTU: [Documentation] Justification for removal of UBUNTU commits
2c125cc 
This is an empty commit for documentation purposes only.

Historically, some old and unused firmware was removed by directly purging
the firmware files from the repo with UBUNTU commits or by reverting the
relevant upstream commits. Subsequent UBUNTU commits cleaned up the WHENCE
file and removed stale entries so that the check-whence.py checker is
happy.

Recent changes introduced the concept of listing firmware files, that
should not be packaged, in a separate file debian/remove-firmware.list.
These changes also included the reverting of the above mentioned commits
and the addition of the 'removed' firmware files to remove-firmware.list so
that the resulting package content doesn't change.

With that, we ended up with 5 commits per firmware removal set:
  1) The original firmware removal commit
  2) The subsequent WHENCE fixup
  3) The revert of #2
  4) The revert of #1
  5) The addition of the 'removed' firmware files to remove-firmware.list

This is not ideal since a) upstream files are modified (WHENCE) and deleted
for the sole purpose of not packaging them and b) because of that,
subsequent rebases to latest upstream could result in conflicts.

For these reasons, it was decided to alter the history of this branch and
remove commits #1 to #4 and only keep #5. Note that some of the #1 commits
unfortunately touched both upstream and UBUNTU files. Only the
modifications of upstream files was removed, the UBUNTU modifications
needed to be kept.

Both branch commits (before and after the rebase and removal of commits)
are tagged and it was verified, that the repo content at these tags is
identical (except for debian/changelog). More specifically, the 'before'
tag is:
  Ubuntu-20220217.git6342082c-0ubuntu2
and the 'after' tag is:
  Ubuntu-20220217.git6342082c-0ubuntu3

$ git diff --name-only Ubuntu-20220217.git6342082c-0ubuntu2 Ubuntu-20220217.git6342082c-0ubuntu3
debian/changelog

Removed #1 commits:

563bb48ed143 ("UBUNTU: Remove amd64-microcode")
251237583bdd ("UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices"")
513a97a03fba ("UBUNTU: Remove obsolete bnx2x firmware files")
935dc770957e ("UBUNTU: Remove obsolete tr_smctr firmware")
1be4f28f91fb ("UBUNTU: Remove obsolete ti-connectivity firmware")
3d183a325fec ("UBUNTU: Remove obsolete tda1004x firmware")
09e02976b05b ("UBUNTU: Remove obsolete sxg firmware")
9b6d6bbcbc18 ("UBUNTU: Remove obsolete myricom firmware")
bfa2ac04ade6 ("UBUNTU: Remove obsolete mwl8k firmware")
a46068ae4580 ("UBUNTU: Remove obsolete libertas firmware")
1faeeb10de57 ("UBUNTU: Remove obsolete Computone firmware")
22f2239919d9 ("UBUNTU: Remove obsolete dabusb firmware")
03310ea1e1e7 ("UBUNTU: Remove obsolete cxgb firmware")
064c4d3944e4 ("UBUNTU: Remove obsolete bnx2x firmware")
4ce08856dee0 ("UBUNTU: Remove obsolete ar9170 firmware")
c5a7aadccbfd ("UBUNTU: Remove obsolete ar7010 firmware")
f11a59536386 ("UBUNTU: Remove obsolete ath3k firmware")
2188b4baf819 ("UBUNTU: Remove obsolete 3com firmware")
0470cfcec635 ("UBUNT: Remove obsolete ath6k firmware")
e55ef4edc755 ("UBUNTU: Remove obsolete slicoss firmware")
0563995d173f ("UBUNTU: Remove obsolete ath9k firmware")
85ee46eb9136 ("UBUNTU: Remove obsolete ar3k firmware")
4f7cf7c3ecd1 ("UBUNTU: Remove obsolete bnx2x firmware files")
634d7ba9a08a ("UBUNTU: Remove obsolete iwlwifi ucode files")
ee2de66a5c8e ("UBUNTU: Drop obsolete cxgb3 firmware")
6a312e01f665 ("UBUNTU: Remove obsolete ueagle-atm firmware")

Removed #2 commits:

6364dccf3cf6 ("UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE")
0ee3db9fc288 ("UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE")
b5b56ccff00e ("UBUNTU: SAUCE: Remove obsolete files from WHENCE")
a627a307ae5d ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
0398c63ad4d5 ("UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE")
fe771637f2fb ("UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE")
67bde05fdf67 ("UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE")
bf1184377246 ("UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE")
554e29696398 ("UBUNTU: SAUCE: Remove obsolete 3com from WHENCE")
e89cc56af2a8 ("UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE")
19f93a469a30 ("UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE")
f7512d3ddbf2 ("UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE")
5374033d6cf9 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
7cb7df9d1b4c ("UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE")
c2f8f6087c71 ("UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE")
a3b4bfb6350c ("UBUNTU: SAUCE: Remove obsolete Computone from WHENCE")
0b25767b762e ("UBUNTU: SAUCE: Remove obsolete libertas from WHENCE")
9f505e5b38df ("UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE")
e134bb085a93 ("UBUNTU: SAUCE: Remove obsolete myricom from WHENCE")
c9d47ad1bb5c ("UBUNTU: SAUCE: Remove obsolete sxg from WHENCE")
69898586dda3 ("UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE")
e0c45aa236cb ("UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE")
c34fd0ed78aa ("UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE")
df2becc5ae36 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")

Removed #3 commits:

f25df0ab5d6d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
4685558a4306 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE"")
70de9f30507c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE"")
bfa02d2d78a9 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE"")
8602072bdc09 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete sxg from WHENCE"")
1664c8e4d112 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete myricom from WHENCE"")
ffe2b36ab183 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE"")
508a753ad4c6 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete libertas from WHENCE"")
5bc8c64aff3f ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete Computone from WHENCE"")
ca1e98863330 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE"")
1945d6ce8444 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE"")
e04f6f209c3c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
501fa54d2536 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE"")
afb50e6a581b ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE"")
44ddba93c32c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE"")
8436648da231 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete 3com from WHENCE"")
2f1d2d02682e ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE"")
a44e92ce40cd ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE"")
a32264fb18e1 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE"")
363cee77ee86 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE"")
e1a84a4030ed ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
9ea39053a338 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete files from WHENCE"")
c7cc420416ee ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE"")
87b90b7c960d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE"")

Removed #4 commits:

ccc1fe51b7a8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove amd64-microcode"")
b414629bc096 ("UBUNTU: SAUCE: Revert "UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices""")
e49792d86191 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
85e465fe789e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tr_smctr firmware"")
98a9f407adf8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ti-connectivity firmware"")
cd3774f837d1 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tda1004x firmware"")
8a3b516d3e19 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete sxg firmware"")
fe5d0c811d2b ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete myricom firmware"")
ef6bd3107d68 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete mwl8k firmware"")
c8efb5b021ef ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete libertas firmware"")
98d8fc5449ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete Computone firmware"")
fd9d93689df4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete dabusb firmware"")
65c6ff98909f ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete cxgb firmware"")
f13124a09e4d ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware"")
176127bd41dd ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar9170 firmware"")
158bb95bad45 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar7010 firmware"")
898ffa58b927 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath3k firmware"")
be2094113362 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete 3com firmware"")
cd64bbc67264 ("UBUNTU: SAUCE: Revert "UBUNT: Remove obsolete ath6k firmware"")
3748946211c8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete slicoss firmware"")
5ca659c4e7d8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath9k firmware"")
4810ffeb8be9 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar3k firmware"")
c460239b267e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
9f64056d66ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete iwlwifi ucode files"")
9446e4477c8c ("UBUNTU: SAUCE: Revert "UBUNTU: Drop obsolete cxgb3 firmware"")
eff4f433b3b4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ueagle-atm firmware"")

Signed-off-by: Juerg Haefliger <juergh@canonical.com>
mmstick pushed a commit that referenced this issue Nov 21, 2023
@juergh
UBUNTU: [Documentation] Justification for removal of UBUNTU commits
5a1177a 
This is an empty commit for documentation purposes only.

Historically, some old and unused firmware was removed by directly purging
the firmware files from the repo with UBUNTU commits or by reverting the
relevant upstream commits. Subsequent UBUNTU commits cleaned up the WHENCE
file and removed stale entries so that the check-whence.py checker is
happy.

Recent changes introduced the concept of listing firmware files, that
should not be packaged, in a separate file debian/remove-firmware.list.
These changes also included the reverting of the above mentioned commits
and the addition of the 'removed' firmware files to remove-firmware.list so
that the resulting package content doesn't change.

With that, we ended up with 5 commits per firmware removal set:
  1) The original firmware removal commit
  2) The subsequent WHENCE fixup
  3) The revert of #2
  4) The revert of #1
  5) The addition of the 'removed' firmware files to remove-firmware.list

This is not ideal since a) upstream files are modified (WHENCE) and deleted
for the sole purpose of not packaging them and b) because of that,
subsequent rebases to latest upstream could result in conflicts.

For these reasons, it was decided to alter the history of this branch and
remove commits #1 to #4 and only keep #5. Note that some of the #1 commits
unfortunately touched both upstream and UBUNTU files. Only the
modifications of upstream files was removed, the UBUNTU modifications
needed to be kept.

Both branch commits (before and after the rebase and removal of commits)
are tagged and it was verified, that the repo content at these tags is
identical (except for debian/changelog). More specifically, the 'before'
tag is:
  Ubuntu-20220217.git6342082c-0ubuntu2
and the 'after' tag is:
  Ubuntu-20220217.git6342082c-0ubuntu3

$ git diff --name-only Ubuntu-20220217.git6342082c-0ubuntu2 Ubuntu-20220217.git6342082c-0ubuntu3
debian/changelog

Removed #1 commits:

563bb48ed143 ("UBUNTU: Remove amd64-microcode")
251237583bdd ("UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices"")
513a97a03fba ("UBUNTU: Remove obsolete bnx2x firmware files")
935dc770957e ("UBUNTU: Remove obsolete tr_smctr firmware")
1be4f28f91fb ("UBUNTU: Remove obsolete ti-connectivity firmware")
3d183a325fec ("UBUNTU: Remove obsolete tda1004x firmware")
09e02976b05b ("UBUNTU: Remove obsolete sxg firmware")
9b6d6bbcbc18 ("UBUNTU: Remove obsolete myricom firmware")
bfa2ac04ade6 ("UBUNTU: Remove obsolete mwl8k firmware")
a46068ae4580 ("UBUNTU: Remove obsolete libertas firmware")
1faeeb10de57 ("UBUNTU: Remove obsolete Computone firmware")
22f2239919d9 ("UBUNTU: Remove obsolete dabusb firmware")
03310ea1e1e7 ("UBUNTU: Remove obsolete cxgb firmware")
064c4d3944e4 ("UBUNTU: Remove obsolete bnx2x firmware")
4ce08856dee0 ("UBUNTU: Remove obsolete ar9170 firmware")
c5a7aadccbfd ("UBUNTU: Remove obsolete ar7010 firmware")
f11a59536386 ("UBUNTU: Remove obsolete ath3k firmware")
2188b4baf819 ("UBUNTU: Remove obsolete 3com firmware")
0470cfcec635 ("UBUNT: Remove obsolete ath6k firmware")
e55ef4edc755 ("UBUNTU: Remove obsolete slicoss firmware")
0563995d173f ("UBUNTU: Remove obsolete ath9k firmware")
85ee46eb9136 ("UBUNTU: Remove obsolete ar3k firmware")
4f7cf7c3ecd1 ("UBUNTU: Remove obsolete bnx2x firmware files")
634d7ba9a08a ("UBUNTU: Remove obsolete iwlwifi ucode files")
ee2de66a5c8e ("UBUNTU: Drop obsolete cxgb3 firmware")
6a312e01f665 ("UBUNTU: Remove obsolete ueagle-atm firmware")

Removed #2 commits:

6364dccf3cf6 ("UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE")
0ee3db9fc288 ("UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE")
b5b56ccff00e ("UBUNTU: SAUCE: Remove obsolete files from WHENCE")
a627a307ae5d ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
0398c63ad4d5 ("UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE")
fe771637f2fb ("UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE")
67bde05fdf67 ("UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE")
bf1184377246 ("UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE")
554e29696398 ("UBUNTU: SAUCE: Remove obsolete 3com from WHENCE")
e89cc56af2a8 ("UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE")
19f93a469a30 ("UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE")
f7512d3ddbf2 ("UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE")
5374033d6cf9 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
7cb7df9d1b4c ("UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE")
c2f8f6087c71 ("UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE")
a3b4bfb6350c ("UBUNTU: SAUCE: Remove obsolete Computone from WHENCE")
0b25767b762e ("UBUNTU: SAUCE: Remove obsolete libertas from WHENCE")
9f505e5b38df ("UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE")
e134bb085a93 ("UBUNTU: SAUCE: Remove obsolete myricom from WHENCE")
c9d47ad1bb5c ("UBUNTU: SAUCE: Remove obsolete sxg from WHENCE")
69898586dda3 ("UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE")
e0c45aa236cb ("UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE")
c34fd0ed78aa ("UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE")
df2becc5ae36 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")

Removed #3 commits:

f25df0ab5d6d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
4685558a4306 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE"")
70de9f30507c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE"")
bfa02d2d78a9 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE"")
8602072bdc09 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete sxg from WHENCE"")
1664c8e4d112 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete myricom from WHENCE"")
ffe2b36ab183 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE"")
508a753ad4c6 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete libertas from WHENCE"")
5bc8c64aff3f ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete Computone from WHENCE"")
ca1e98863330 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE"")
1945d6ce8444 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE"")
e04f6f209c3c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
501fa54d2536 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE"")
afb50e6a581b ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE"")
44ddba93c32c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE"")
8436648da231 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete 3com from WHENCE"")
2f1d2d02682e ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE"")
a44e92ce40cd ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE"")
a32264fb18e1 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE"")
363cee77ee86 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE"")
e1a84a4030ed ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
9ea39053a338 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete files from WHENCE"")
c7cc420416ee ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE"")
87b90b7c960d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE"")

Removed #4 commits:

ccc1fe51b7a8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove amd64-microcode"")
b414629bc096 ("UBUNTU: SAUCE: Revert "UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices""")
e49792d86191 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
85e465fe789e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tr_smctr firmware"")
98a9f407adf8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ti-connectivity firmware"")
cd3774f837d1 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tda1004x firmware"")
8a3b516d3e19 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete sxg firmware"")
fe5d0c811d2b ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete myricom firmware"")
ef6bd3107d68 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete mwl8k firmware"")
c8efb5b021ef ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete libertas firmware"")
98d8fc5449ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete Computone firmware"")
fd9d93689df4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete dabusb firmware"")
65c6ff98909f ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete cxgb firmware"")
f13124a09e4d ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware"")
176127bd41dd ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar9170 firmware"")
158bb95bad45 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar7010 firmware"")
898ffa58b927 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath3k firmware"")
be2094113362 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete 3com firmware"")
cd64bbc67264 ("UBUNTU: SAUCE: Revert "UBUNT: Remove obsolete ath6k firmware"")
3748946211c8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete slicoss firmware"")
5ca659c4e7d8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath9k firmware"")
4810ffeb8be9 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar3k firmware"")
c460239b267e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
9f64056d66ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete iwlwifi ucode files"")
9446e4477c8c ("UBUNTU: SAUCE: Revert "UBUNTU: Drop obsolete cxgb3 firmware"")
eff4f433b3b4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ueagle-atm firmware"")

Signed-off-by: Juerg Haefliger <juergh@canonical.com>
mmstick pushed a commit that referenced this issue Feb 2, 2024
@juergh
UBUNTU: [Documentation] Justification for removal of UBUNTU commits
a063ca5 
This is an empty commit for documentation purposes only.

Historically, some old and unused firmware was removed by directly purging
the firmware files from the repo with UBUNTU commits or by reverting the
relevant upstream commits. Subsequent UBUNTU commits cleaned up the WHENCE
file and removed stale entries so that the check-whence.py checker is
happy.

Recent changes introduced the concept of listing firmware files, that
should not be packaged, in a separate file debian/remove-firmware.list.
These changes also included the reverting of the above mentioned commits
and the addition of the 'removed' firmware files to remove-firmware.list so
that the resulting package content doesn't change.

With that, we ended up with 5 commits per firmware removal set:
  1) The original firmware removal commit
  2) The subsequent WHENCE fixup
  3) The revert of #2
  4) The revert of #1
  5) The addition of the 'removed' firmware files to remove-firmware.list

This is not ideal since a) upstream files are modified (WHENCE) and deleted
for the sole purpose of not packaging them and b) because of that,
subsequent rebases to latest upstream could result in conflicts.

For these reasons, it was decided to alter the history of this branch and
remove commits #1 to #4 and only keep #5. Note that some of the #1 commits
unfortunately touched both upstream and UBUNTU files. Only the
modifications of upstream files was removed, the UBUNTU modifications
needed to be kept.

Both branch commits (before and after the rebase and removal of commits)
are tagged and it was verified, that the repo content at these tags is
identical (except for debian/changelog). More specifically, the 'before'
tag is:
  Ubuntu-20220217.git6342082c-0ubuntu2
and the 'after' tag is:
  Ubuntu-20220217.git6342082c-0ubuntu3

$ git diff --name-only Ubuntu-20220217.git6342082c-0ubuntu2 Ubuntu-20220217.git6342082c-0ubuntu3
debian/changelog

Removed #1 commits:

563bb48ed143 ("UBUNTU: Remove amd64-microcode")
251237583bdd ("UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices"")
513a97a03fba ("UBUNTU: Remove obsolete bnx2x firmware files")
935dc770957e ("UBUNTU: Remove obsolete tr_smctr firmware")
1be4f28f91fb ("UBUNTU: Remove obsolete ti-connectivity firmware")
3d183a325fec ("UBUNTU: Remove obsolete tda1004x firmware")
09e02976b05b ("UBUNTU: Remove obsolete sxg firmware")
9b6d6bbcbc18 ("UBUNTU: Remove obsolete myricom firmware")
bfa2ac04ade6 ("UBUNTU: Remove obsolete mwl8k firmware")
a46068ae4580 ("UBUNTU: Remove obsolete libertas firmware")
1faeeb10de57 ("UBUNTU: Remove obsolete Computone firmware")
22f2239919d9 ("UBUNTU: Remove obsolete dabusb firmware")
03310ea1e1e7 ("UBUNTU: Remove obsolete cxgb firmware")
064c4d3944e4 ("UBUNTU: Remove obsolete bnx2x firmware")
4ce08856dee0 ("UBUNTU: Remove obsolete ar9170 firmware")
c5a7aadccbfd ("UBUNTU: Remove obsolete ar7010 firmware")
f11a59536386 ("UBUNTU: Remove obsolete ath3k firmware")
2188b4baf819 ("UBUNTU: Remove obsolete 3com firmware")
0470cfcec635 ("UBUNT: Remove obsolete ath6k firmware")
e55ef4edc755 ("UBUNTU: Remove obsolete slicoss firmware")
0563995d173f ("UBUNTU: Remove obsolete ath9k firmware")
85ee46eb9136 ("UBUNTU: Remove obsolete ar3k firmware")
4f7cf7c3ecd1 ("UBUNTU: Remove obsolete bnx2x firmware files")
634d7ba9a08a ("UBUNTU: Remove obsolete iwlwifi ucode files")
ee2de66a5c8e ("UBUNTU: Drop obsolete cxgb3 firmware")
6a312e01f665 ("UBUNTU: Remove obsolete ueagle-atm firmware")

Removed #2 commits:

6364dccf3cf6 ("UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE")
0ee3db9fc288 ("UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE")
b5b56ccff00e ("UBUNTU: SAUCE: Remove obsolete files from WHENCE")
a627a307ae5d ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
0398c63ad4d5 ("UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE")
fe771637f2fb ("UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE")
67bde05fdf67 ("UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE")
bf1184377246 ("UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE")
554e29696398 ("UBUNTU: SAUCE: Remove obsolete 3com from WHENCE")
e89cc56af2a8 ("UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE")
19f93a469a30 ("UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE")
f7512d3ddbf2 ("UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE")
5374033d6cf9 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
7cb7df9d1b4c ("UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE")
c2f8f6087c71 ("UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE")
a3b4bfb6350c ("UBUNTU: SAUCE: Remove obsolete Computone from WHENCE")
0b25767b762e ("UBUNTU: SAUCE: Remove obsolete libertas from WHENCE")
9f505e5b38df ("UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE")
e134bb085a93 ("UBUNTU: SAUCE: Remove obsolete myricom from WHENCE")
c9d47ad1bb5c ("UBUNTU: SAUCE: Remove obsolete sxg from WHENCE")
69898586dda3 ("UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE")
e0c45aa236cb ("UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE")
c34fd0ed78aa ("UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE")
df2becc5ae36 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")

Removed #3 commits:

f25df0ab5d6d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
4685558a4306 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE"")
70de9f30507c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE"")
bfa02d2d78a9 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE"")
8602072bdc09 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete sxg from WHENCE"")
1664c8e4d112 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete myricom from WHENCE"")
ffe2b36ab183 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE"")
508a753ad4c6 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete libertas from WHENCE"")
5bc8c64aff3f ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete Computone from WHENCE"")
ca1e98863330 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE"")
1945d6ce8444 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE"")
e04f6f209c3c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
501fa54d2536 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE"")
afb50e6a581b ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE"")
44ddba93c32c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE"")
8436648da231 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete 3com from WHENCE"")
2f1d2d02682e ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE"")
a44e92ce40cd ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE"")
a32264fb18e1 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE"")
363cee77ee86 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE"")
e1a84a4030ed ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
9ea39053a338 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete files from WHENCE"")
c7cc420416ee ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE"")
87b90b7c960d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE"")

Removed #4 commits:

ccc1fe51b7a8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove amd64-microcode"")
b414629bc096 ("UBUNTU: SAUCE: Revert "UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices""")
e49792d86191 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
85e465fe789e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tr_smctr firmware"")
98a9f407adf8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ti-connectivity firmware"")
cd3774f837d1 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tda1004x firmware"")
8a3b516d3e19 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete sxg firmware"")
fe5d0c811d2b ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete myricom firmware"")
ef6bd3107d68 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete mwl8k firmware"")
c8efb5b021ef ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete libertas firmware"")
98d8fc5449ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete Computone firmware"")
fd9d93689df4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete dabusb firmware"")
65c6ff98909f ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete cxgb firmware"")
f13124a09e4d ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware"")
176127bd41dd ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar9170 firmware"")
158bb95bad45 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar7010 firmware"")
898ffa58b927 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath3k firmware"")
be2094113362 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete 3com firmware"")
cd64bbc67264 ("UBUNTU: SAUCE: Revert "UBUNT: Remove obsolete ath6k firmware"")
3748946211c8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete slicoss firmware"")
5ca659c4e7d8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath9k firmware"")
4810ffeb8be9 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar3k firmware"")
c460239b267e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
9f64056d66ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete iwlwifi ucode files"")
9446e4477c8c ("UBUNTU: SAUCE: Revert "UBUNTU: Drop obsolete cxgb3 firmware"")
eff4f433b3b4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ueagle-atm firmware"")

Signed-off-by: Juerg Haefliger <juergh@canonical.com>
mmstick pushed a commit that referenced this issue Mar 20, 2024
@juergh
UBUNTU: [Documentation] Justification for removal of UBUNTU commits
b9fd1c6 
This is an empty commit for documentation purposes only.

Historically, some old and unused firmware was removed by directly purging
the firmware files from the repo with UBUNTU commits or by reverting the
relevant upstream commits. Subsequent UBUNTU commits cleaned up the WHENCE
file and removed stale entries so that the check-whence.py checker is
happy.

Recent changes introduced the concept of listing firmware files, that
should not be packaged, in a separate file debian/remove-firmware.list.
These changes also included the reverting of the above mentioned commits
and the addition of the 'removed' firmware files to remove-firmware.list so
that the resulting package content doesn't change.

With that, we ended up with 5 commits per firmware removal set:
  1) The original firmware removal commit
  2) The subsequent WHENCE fixup
  3) The revert of #2
  4) The revert of #1
  5) The addition of the 'removed' firmware files to remove-firmware.list

This is not ideal since a) upstream files are modified (WHENCE) and deleted
for the sole purpose of not packaging them and b) because of that,
subsequent rebases to latest upstream could result in conflicts.

For these reasons, it was decided to alter the history of this branch and
remove commits #1 to #4 and only keep #5. Note that some of the #1 commits
unfortunately touched both upstream and UBUNTU files. Only the
modifications of upstream files was removed, the UBUNTU modifications
needed to be kept.

Both branch commits (before and after the rebase and removal of commits)
are tagged and it was verified, that the repo content at these tags is
identical (except for debian/changelog). More specifically, the 'before'
tag is:
  Ubuntu-20220217.git6342082c-0ubuntu2
and the 'after' tag is:
  Ubuntu-20220217.git6342082c-0ubuntu3

$ git diff --name-only Ubuntu-20220217.git6342082c-0ubuntu2 Ubuntu-20220217.git6342082c-0ubuntu3
debian/changelog

Removed #1 commits:

563bb48ed143 ("UBUNTU: Remove amd64-microcode")
251237583bdd ("UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices"")
513a97a03fba ("UBUNTU: Remove obsolete bnx2x firmware files")
935dc770957e ("UBUNTU: Remove obsolete tr_smctr firmware")
1be4f28f91fb ("UBUNTU: Remove obsolete ti-connectivity firmware")
3d183a325fec ("UBUNTU: Remove obsolete tda1004x firmware")
09e02976b05b ("UBUNTU: Remove obsolete sxg firmware")
9b6d6bbcbc18 ("UBUNTU: Remove obsolete myricom firmware")
bfa2ac04ade6 ("UBUNTU: Remove obsolete mwl8k firmware")
a46068ae4580 ("UBUNTU: Remove obsolete libertas firmware")
1faeeb10de57 ("UBUNTU: Remove obsolete Computone firmware")
22f2239919d9 ("UBUNTU: Remove obsolete dabusb firmware")
03310ea1e1e7 ("UBUNTU: Remove obsolete cxgb firmware")
064c4d3944e4 ("UBUNTU: Remove obsolete bnx2x firmware")
4ce08856dee0 ("UBUNTU: Remove obsolete ar9170 firmware")
c5a7aadccbfd ("UBUNTU: Remove obsolete ar7010 firmware")
f11a59536386 ("UBUNTU: Remove obsolete ath3k firmware")
2188b4baf819 ("UBUNTU: Remove obsolete 3com firmware")
0470cfcec635 ("UBUNT: Remove obsolete ath6k firmware")
e55ef4edc755 ("UBUNTU: Remove obsolete slicoss firmware")
0563995d173f ("UBUNTU: Remove obsolete ath9k firmware")
85ee46eb9136 ("UBUNTU: Remove obsolete ar3k firmware")
4f7cf7c3ecd1 ("UBUNTU: Remove obsolete bnx2x firmware files")
634d7ba9a08a ("UBUNTU: Remove obsolete iwlwifi ucode files")
ee2de66a5c8e ("UBUNTU: Drop obsolete cxgb3 firmware")
6a312e01f665 ("UBUNTU: Remove obsolete ueagle-atm firmware")

Removed #2 commits:

6364dccf3cf6 ("UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE")
0ee3db9fc288 ("UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE")
b5b56ccff00e ("UBUNTU: SAUCE: Remove obsolete files from WHENCE")
a627a307ae5d ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
0398c63ad4d5 ("UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE")
fe771637f2fb ("UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE")
67bde05fdf67 ("UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE")
bf1184377246 ("UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE")
554e29696398 ("UBUNTU: SAUCE: Remove obsolete 3com from WHENCE")
e89cc56af2a8 ("UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE")
19f93a469a30 ("UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE")
f7512d3ddbf2 ("UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE")
5374033d6cf9 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")
7cb7df9d1b4c ("UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE")
c2f8f6087c71 ("UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE")
a3b4bfb6350c ("UBUNTU: SAUCE: Remove obsolete Computone from WHENCE")
0b25767b762e ("UBUNTU: SAUCE: Remove obsolete libertas from WHENCE")
9f505e5b38df ("UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE")
e134bb085a93 ("UBUNTU: SAUCE: Remove obsolete myricom from WHENCE")
c9d47ad1bb5c ("UBUNTU: SAUCE: Remove obsolete sxg from WHENCE")
69898586dda3 ("UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE")
e0c45aa236cb ("UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE")
c34fd0ed78aa ("UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE")
df2becc5ae36 ("UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE")

Removed #3 commits:

f25df0ab5d6d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
4685558a4306 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tr_smctr from WHENCE"")
70de9f30507c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ti-connectivity from WHENCE"")
bfa02d2d78a9 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete tda7706 from WHENCE"")
8602072bdc09 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete sxg from WHENCE"")
1664c8e4d112 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete myricom from WHENCE"")
ffe2b36ab183 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete mwl8k from WHENCE"")
508a753ad4c6 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete libertas from WHENCE"")
5bc8c64aff3f ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete Computone from WHENCE"")
ca1e98863330 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete dabusb from WHENCE"")
1945d6ce8444 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb from WHENCE"")
e04f6f209c3c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
501fa54d2536 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar9170 from WHENCE"")
afb50e6a581b ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar7010 from WHENCE"")
44ddba93c32c ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath3k from WHENCE"")
8436648da231 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete 3com from WHENCE"")
2f1d2d02682e ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath6k from WHENCE"")
a44e92ce40cd ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete slicoss from WHENCE"")
a32264fb18e1 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ath9k from WHENCE"")
363cee77ee86 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ar3k from WHENCE"")
e1a84a4030ed ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete bnx2x from WHENCE"")
9ea39053a338 ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete files from WHENCE"")
c7cc420416ee ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete cxgb3 from WHENCE"")
87b90b7c960d ("UBUNTU: SAUCE: Revert "UBUNTU: SAUCE: Remove obsolete ueagle-atm from WHENCE"")

Removed #4 commits:

ccc1fe51b7a8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove amd64-microcode"")
b414629bc096 ("UBUNTU: SAUCE: Revert "UBUNTU: Revert "linux-firmware: Add firmware files for Siano DTV devices""")
e49792d86191 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
85e465fe789e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tr_smctr firmware"")
98a9f407adf8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ti-connectivity firmware"")
cd3774f837d1 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete tda1004x firmware"")
8a3b516d3e19 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete sxg firmware"")
fe5d0c811d2b ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete myricom firmware"")
ef6bd3107d68 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete mwl8k firmware"")
c8efb5b021ef ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete libertas firmware"")
98d8fc5449ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete Computone firmware"")
fd9d93689df4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete dabusb firmware"")
65c6ff98909f ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete cxgb firmware"")
f13124a09e4d ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware"")
176127bd41dd ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar9170 firmware"")
158bb95bad45 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar7010 firmware"")
898ffa58b927 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath3k firmware"")
be2094113362 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete 3com firmware"")
cd64bbc67264 ("UBUNTU: SAUCE: Revert "UBUNT: Remove obsolete ath6k firmware"")
3748946211c8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete slicoss firmware"")
5ca659c4e7d8 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ath9k firmware"")
4810ffeb8be9 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ar3k firmware"")
c460239b267e ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete bnx2x firmware files"")
9f64056d66ea ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete iwlwifi ucode files"")
9446e4477c8c ("UBUNTU: SAUCE: Revert "UBUNTU: Drop obsolete cxgb3 firmware"")
eff4f433b3b4 ("UBUNTU: SAUCE: Revert "UBUNTU: Remove obsolete ueagle-atm firmware"")

Signed-off-by: Juerg Haefliger <juergh@canonical.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jacobgkau