Update OLD-BEHAVIOUR-DEPRECATION.md
This commit is contained in:
parent
42ec6296f2
commit
8e6d03d349
|
@ -2,11 +2,11 @@
|
|||
|
||||
## Overview
|
||||
|
||||
When I (@mexisme) created the microsoft/surface profile, there weren't that many differences between
|
||||
When the microsoft/surface profile was created, there weren't that many differences between
|
||||
the various models of Surface.
|
||||
|
||||
I had just acquired a Surface Go 1, and it was mostly safe to enable all the options for all the
|
||||
models, and they would fail gracefully enough that we could mostly ignore warnings or errors.
|
||||
e.g. I had just acquired a Surface Go 1, and it was mostly safe to enable all the options for all the
|
||||
models, and they would fail gracefully enough that you could mostly ignore warnings or errors.
|
||||
|
||||
Now, however --- as-of 2023-01-10 --- we have a much wider variety of chipsets, incl. models with
|
||||
some of the newer AMD CPUs, and this is breaking small things in annoying ways for more people.
|
||||
|
@ -31,9 +31,6 @@ microsoft/surface profile to make it easier for people to specialise for their h
|
|||
Any code or modules that are specialised for a Surface model now have their own directory under this
|
||||
top-level.
|
||||
|
||||
E.g. I am moving the Surface Go specialisations into `surface-go/`, and there may be further
|
||||
specialisations like `surface-go-3/`.
|
||||
|
||||
### "Common" modules
|
||||
|
||||
All the "common" modules that were once in the top-level of the microsoft/surface profile have moved
|
||||
|
@ -41,16 +38,7 @@ under the `common/` directory.
|
|||
|
||||
Tools / services that are shared among several models are now extracted to their own module under
|
||||
`common/` and imported by `common/default.nix`.
|
||||
These new "common" modules now have an `enable` option, which is `false` by default.
|
||||
|
||||
### "Deprecated Behaviour" module
|
||||
|
||||
The original `./default.nix` module has been replaced by a new `deprecated/` module, which replicates the
|
||||
original behaviour.
|
||||
|
||||
The new `./default.nix` will load the new `deprecated/` module, but will also pop-up a warning asking users
|
||||
to update how they use the microsoft/surface profile from now on.
|
||||
This warning will probably change to a fail assertion at some point in the future.
|
||||
Most "common" modules now have an `enable` option, which is `false` by default.
|
||||
|
||||
## Adding a new Model Specialisation
|
||||
|
||||
|
|
Loading…
Reference in a new issue