annotate doc/Makefile @ 4212:5f2d496c633f
core: get rid of `pickle`:
Use of `pickle` to serialise data was a technical legacy that was causing trouble to store
in database, to update (if a class was serialised, a change could break update), and to
security (pickle can lead to code execution).
This patch remove all use of Pickle in favour in JSON, notably:
- for caching data, a Pydantic model is now used instead
- for SQLAlchemy model, the LegacyPickle is replaced by JSON serialisation
- in XEP-0373 a class `PublicKeyMetadata` was serialised. New method `from_dict` and
`to_dict` method have been implemented to do serialisation.
- new methods to (de)serialise data can now be specified with Identity data types. It is
notably used to (de)serialise `path` of avatars.
A migration script has been created to convert data (for upgrade or downgrade), with
special care for XEP-0373 case. Depending of size of database, this migration script can
be long to run.
rel 443
| author |
Goffi <goffi@goffi.org> |
| date |
Fri, 23 Feb 2024 13:31:04 +0100 |
| parents |
ce16847a7b6d |
| children |
|
| rev |
line source |
|
2946
|
1 # Minimal makefile for Sphinx documentation |
|
|
2 # |
|
|
3 |
|
|
4 # You can set these variables from the command line. |
|
|
5 SPHINXOPTS = |
|
|
6 SPHINXBUILD = sphinx-build |
|
|
7 SOURCEDIR = . |
|
|
8 BUILDDIR = .build |
|
|
9 |
|
|
10 # Put it first so that "make" without argument is like "make help". |
|
|
11 help: |
|
|
12 @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
|
|
13 |
|
|
14 .PHONY: help Makefile |
|
|
15 |
|
|
16 # Catch-all target: route all unknown targets to Sphinx using the new |
|
|
17 # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). |
|
|
18 %: Makefile |
|
|
19 @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
