17a352cc70
cachefiles: document on-demand read mode
...
JIRA: https://issues.redhat.com/browse/RHEL-31991
Upstream status: Linus
commit 99302ebd3af7895cb5312e80e65d4db5aed5a72d
Author: Jeffle Xu <jefflexu@linux.alibaba.com>
Date: Mon Apr 25 20:21:30 2022 +0800
cachefiles: document on-demand read mode
Document new user interface introduced by on-demand read mode.
Signed-off-by: Jeffle Xu <jefflexu@linux.alibaba.com>
Link: https://lore.kernel.org/r/20220509074028.74954-9-jefflexu@linux.alibaba.com
Acked-by: David Howells <dhowells@redhat.com>
Signed-off-by: Gao Xiang <hsiangkao@linux.alibaba.com>
Signed-off-by: Ian Kent <ikent@redhat.com>
2025-01-17 18:59:13 +08:00
edb3ae6d12
fscache: Rewrite documentation
...
Conflicts: Documentation/filesystems/caching/netfs-api.rst -
We already have
2c547f299827 ("fscache: Remove the cookie parameter from fscache_clear_p
age_bits()")
so keep description for fscache_clear_page_bits
Bugzilla: https://bugzilla.redhat.com/2120352
commit e0484344c0413e1fcd5642b77d49c7648fb194ec
Author: David Howells <dhowells@redhat.com>
Date: Wed Nov 10 13:25:03 2021 +0000
fscache: Rewrite documentation
Rewrite the fscache documentation.
Changes
=======
ver #3 :
- The volume coherency data is now an arbitrarily-sized blob, not a u64.
ver #2 :
- Put quoting around some bits of C being referred to in the docs[1].
- Stripped the markup off the ref to the netfs lib doc[2].
Signed-off-by: David Howells <dhowells@redhat.com>
Reviewed-by: Jeff Layton <jlayton@kernel.org>
cc: linux-cachefs@redhat.com
Link: https://lore.kernel.org/r/20211130175119.63d0e7aa@canb.auug.org.au/ [1
]
Link: https://lore.kernel.org/r/20211130162311.105fcfa5@canb.auug.org.au/ [2
]
Link: https://lore.kernel.org/r/163819672252.215744.15454333549935901588.stg
it@warthog.procyon.org.uk/ # v1
Link: https://lore.kernel.org/r/163906986754.143852.17703291789683936950.stg
it@warthog.procyon.org.uk/ # v2
Link: https://lore.kernel.org/r/163967193834.1823006.15991526817786159772.st
git@warthog.procyon.org.uk/ # v3
Link: https://lore.kernel.org/r/164021585970.640689.3162537597817521032.stgi
t@warthog.procyon.org.uk/ # v4
Signed-off-by: Chris von Recklinghausen <crecklin@redhat.com>
2022-10-12 07:27:37 -04:00
7f01cfb9e8
docs: filesystems: Replace HTTP links with HTTPS ones
...
Rationale:
Reduces attack surface on kernel devs opening the links for MITM
as HTTPS traffic is much harder to manipulate.
Deterministic algorithm:
For each file:
If not .svg:
For each line:
If doesn't contain `\bxmlns\b`:
For each link, `\bhttp://[^# \t\r\n]*(?:\w|/)`:
If neither `\bgnu\.org/license`, nor `\bmozilla\.org/MPL\b`:
If both the HTTP and HTTPS versions
return 200 OK and serve the same content:
Replace HTTP with HTTPS.
Signed-off-by: Alexander A. Klimov <grandmaster@al2klimov.de>
Link: https://lore.kernel.org/r/20200713113705.33773-1-grandmaster@al2klimov.de
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-07-13 09:33:22 -06:00
d74802ade7
docs: filesystems: caching/cachefiles.txt: convert to ReST
...
- Add a SPDX header;
- Adjust document title;
- Mark literal blocks as such;
- Add table markups;
- Comment out text ToC for html/pdf output;
- Add lists markups;
- Add it to filesystems/caching/index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/eec0cfc268e8dca348f760224685100c9c2caba6.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-05-05 09:22:21 -06:00
Ian Kent
Chris von Recklinghausen
Alexander A. Klimov
Mauro Carvalho Chehab