diff mbox series

[Noble/Unstable,6/6] UBUNTU: [Packaging] Remove README.inclusion-list

Message ID 20231124132836.92441-7-juerg.haefliger@canonical.com
State New
Headers show
Series Remove obsolete packaging bits and pieces | expand

Commit Message

Juerg Haefliger Nov. 24, 2023, 1:28 p.m. UTC
It's an old README from 2010 that contains some notes for kernel
maintainers. It hasn't been updated since and is not packaged, so
drop it.

Signed-off-by: Juerg Haefliger <juerg.haefliger@canonical.com>
---
 debian/docs/README.inclusion-list | 51 -------------------------------
 1 file changed, 51 deletions(-)
 delete mode 100644 debian/docs/README.inclusion-list

Comments

Masahiro Yamada Dec. 4, 2023, 4:33 p.m. UTC | #1
On Fri, Nov 24, 2023 at 10:31 PM Juerg Haefliger
<juerg.haefliger@canonical.com> wrote:
>
> It's an old README from 2010 that contains some notes for kernel
> maintainers. It hasn't been updated since and is not packaged, so
> drop it.
>
> Signed-off-by: Juerg Haefliger <juerg.haefliger@canonical.com>


Agree.

The second paragraph of this document would be even more confusing
after the removal of the sub-flavours feature.




Acked-by: Masahiro Yamada <masahiro.yamada@canonical.com>







> ---
>  debian/docs/README.inclusion-list | 51 -------------------------------
>  1 file changed, 51 deletions(-)
>  delete mode 100644 debian/docs/README.inclusion-list
>
> diff --git a/debian/docs/README.inclusion-list b/debian/docs/README.inclusion-list
> deleted file mode 100644
> index b025393e7c19..000000000000
> --- a/debian/docs/README.inclusion-list
> +++ /dev/null
> @@ -1,51 +0,0 @@
> -This README describes the reason for, and the use of, module
> -inclusion lists.
> -
> -The original Hardy release had the notion of sub-flavours,
> -e.g., a flavour that was constructed as a subset of an existing flavour.
> -For example, the virtual flavour was extracted from the server flavour using
> -a subset of the server flavour modules. However, there were some difficult
> -mainteneance issues with regard to packaging, make rules, and scripts. This
> -re-implementation of the sub-flavours philosophy is hopefully simpler,
> -and retrofitable to all releases.
> -
> -A module inclusion list looks at the problem of of constructing a package
> -from the perspective of what modules do we _want_ in the package, as opposed
> -to what modules we _don't_ want. As the kernel matures, more and more devices are added
> -which makes the problem of configuration maintenance a real pain in the ass.
> -If we took the approach of disabling all of the config options that we don't want,
> -then the differences between flavours will quickly become quite large, making
> -it difficult to quickly compare the individual flavour configs.  Each time a
> -new config option is added then we also have to make a decision about disabling in
> -order to continue to keep the minimal number of modules.
> -
> -A module inclusion list is applied on a per-flavour basis. For example,
> -debian.<BRANCH>/control.d/${flavour}.inclusion-list. For example, the
> -config for virtual is very close to server and generic, but the inclusion list
> -causes the virtual package to be constructed with _only_ the modules described
> -in the inclusion list.
> -
> -The inclusion list format is a simple bash regular expression list of files. For example,
> -
> -arch/*/{crypto,kernel,oprofile}
> -drivers/acpi/*
> -drivers/ata/ahci.ko
> -
> -These 3 regular expression forms are suitable for expansion by bash and as inputs to 'find'.
> -See debian/scripts/module-inclusion for details.
> -
> -There are 2 log files created as a side effect of the application of the module
> -inclusion list; $(flavour).inclusion-list.log and $(flavour).depmod.log.
> -
> -$(flavour).inclusion-list.log : This log is created while the inclusion list
> -modules are being copied. If any are missing, then those warnings go in this log.
> -While its not considered a fatal error, you should endevour to correct your inclusion
> -list such that there are no missing modules.
> -
> -$(flavour).depmod.log : The log is created as a result of running depmod on the
> -resulting set of modules. If there are missing symbols then you'll find that information
> -here. Again, you should modify your inclusion list such that there are no missing
> -symbols.
> -
> -Tim Gardner <tim.gardner@canonical.com>
> -June 2, 2010
> --
> 2.40.1
>
>
> --
> kernel-team mailing list
> kernel-team@lists.ubuntu.com
> https://lists.ubuntu.com/mailman/listinfo/kernel-team
diff mbox series

Patch

diff --git a/debian/docs/README.inclusion-list b/debian/docs/README.inclusion-list
deleted file mode 100644
index b025393e7c19..000000000000
--- a/debian/docs/README.inclusion-list
+++ /dev/null
@@ -1,51 +0,0 @@ 
-This README describes the reason for, and the use of, module
-inclusion lists.
-
-The original Hardy release had the notion of sub-flavours,
-e.g., a flavour that was constructed as a subset of an existing flavour.
-For example, the virtual flavour was extracted from the server flavour using
-a subset of the server flavour modules. However, there were some difficult
-mainteneance issues with regard to packaging, make rules, and scripts. This
-re-implementation of the sub-flavours philosophy is hopefully simpler,
-and retrofitable to all releases.
-
-A module inclusion list looks at the problem of of constructing a package
-from the perspective of what modules do we _want_ in the package, as opposed
-to what modules we _don't_ want. As the kernel matures, more and more devices are added
-which makes the problem of configuration maintenance a real pain in the ass.
-If we took the approach of disabling all of the config options that we don't want,
-then the differences between flavours will quickly become quite large, making
-it difficult to quickly compare the individual flavour configs.  Each time a
-new config option is added then we also have to make a decision about disabling in
-order to continue to keep the minimal number of modules.
-
-A module inclusion list is applied on a per-flavour basis. For example,
-debian.<BRANCH>/control.d/${flavour}.inclusion-list. For example, the
-config for virtual is very close to server and generic, but the inclusion list
-causes the virtual package to be constructed with _only_ the modules described 
-in the inclusion list.
-
-The inclusion list format is a simple bash regular expression list of files. For example,
-
-arch/*/{crypto,kernel,oprofile}
-drivers/acpi/*
-drivers/ata/ahci.ko
-
-These 3 regular expression forms are suitable for expansion by bash and as inputs to 'find'.
-See debian/scripts/module-inclusion for details.
-
-There are 2 log files created as a side effect of the application of the module
-inclusion list; $(flavour).inclusion-list.log and $(flavour).depmod.log.
-
-$(flavour).inclusion-list.log : This log is created while the inclusion list
-modules are being copied. If any are missing, then those warnings go in this log.
-While its not considered a fatal error, you should endevour to correct your inclusion
-list such that there are no missing modules.
-
-$(flavour).depmod.log : The log is created as a result of running depmod on the
-resulting set of modules. If there are missing symbols then you'll find that information
-here. Again, you should modify your inclusion list such that there are no missing
-symbols.
-
-Tim Gardner <tim.gardner@canonical.com>
-June 2, 2010