| Message ID | 20230818200630.2719595-4-willy@infradead.org (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | Improve mm documentation | expand |
On 8/18/23 13:06, Matthew Wilcox (Oracle) wrote: > Turn the a), b) into an unordered ReST list and remove the unnecessary > 'Note:' prefix. > > Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org> Acked-by: Randy Dunlap <rdunlap@infradead.org> Thanks. > --- > mm/mapping_dirty_helpers.c | 11 ++++++----- > 1 file changed, 6 insertions(+), 5 deletions(-) > > diff --git a/mm/mapping_dirty_helpers.c b/mm/mapping_dirty_helpers.c > index a26dd8bcfcdb..2f8829b3541a 100644 > --- a/mm/mapping_dirty_helpers.c > +++ b/mm/mapping_dirty_helpers.c > @@ -288,13 +288,14 @@ EXPORT_SYMBOL_GPL(wp_shared_mapping_range); > * @end: Pointer to the number of the last set bit in @bitmap. > * none set. The value is modified as new bits are set by the function. > * > - * Note: When this function returns there is no guarantee that a CPU has > + * When this function returns there is no guarantee that a CPU has > * not already dirtied new ptes. However it will not clean any ptes not > * reported in the bitmap. The guarantees are as follows: > - * a) All ptes dirty when the function starts executing will end up recorded > - * in the bitmap. > - * b) All ptes dirtied after that will either remain dirty, be recorded in the > - * bitmap or both. > + * > + * * All ptes dirty when the function starts executing will end up recorded > + * in the bitmap. > + * * All ptes dirtied after that will either remain dirty, be recorded in the > + * bitmap or both. > * > * If a caller needs to make sure all dirty ptes are picked up and none > * additional are added, it first needs to write-protect the address-space
On Fri, Aug 18, 2023 at 09:06:29PM +0100, Matthew Wilcox (Oracle) wrote: > Turn the a), b) into an unordered ReST list and remove the unnecessary > 'Note:' prefix. > > Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org> Acked-by: Mike Rapoport (IBM) <rppt@kernel.org> > --- > mm/mapping_dirty_helpers.c | 11 ++++++----- > 1 file changed, 6 insertions(+), 5 deletions(-) > > diff --git a/mm/mapping_dirty_helpers.c b/mm/mapping_dirty_helpers.c > index a26dd8bcfcdb..2f8829b3541a 100644 > --- a/mm/mapping_dirty_helpers.c > +++ b/mm/mapping_dirty_helpers.c > @@ -288,13 +288,14 @@ EXPORT_SYMBOL_GPL(wp_shared_mapping_range); > * @end: Pointer to the number of the last set bit in @bitmap. > * none set. The value is modified as new bits are set by the function. > * > - * Note: When this function returns there is no guarantee that a CPU has > + * When this function returns there is no guarantee that a CPU has > * not already dirtied new ptes. However it will not clean any ptes not > * reported in the bitmap. The guarantees are as follows: > - * a) All ptes dirty when the function starts executing will end up recorded > - * in the bitmap. > - * b) All ptes dirtied after that will either remain dirty, be recorded in the > - * bitmap or both. > + * > + * * All ptes dirty when the function starts executing will end up recorded > + * in the bitmap. > + * * All ptes dirtied after that will either remain dirty, be recorded in the > + * bitmap or both. > * > * If a caller needs to make sure all dirty ptes are picked up and none > * additional are added, it first needs to write-protect the address-space > -- > 2.40.1 >
diff --git a/mm/mapping_dirty_helpers.c b/mm/mapping_dirty_helpers.c index a26dd8bcfcdb..2f8829b3541a 100644 --- a/mm/mapping_dirty_helpers.c +++ b/mm/mapping_dirty_helpers.c @@ -288,13 +288,14 @@ EXPORT_SYMBOL_GPL(wp_shared_mapping_range); * @end: Pointer to the number of the last set bit in @bitmap. * none set. The value is modified as new bits are set by the function. * - * Note: When this function returns there is no guarantee that a CPU has + * When this function returns there is no guarantee that a CPU has * not already dirtied new ptes. However it will not clean any ptes not * reported in the bitmap. The guarantees are as follows: - * a) All ptes dirty when the function starts executing will end up recorded - * in the bitmap. - * b) All ptes dirtied after that will either remain dirty, be recorded in the - * bitmap or both. + * + * * All ptes dirty when the function starts executing will end up recorded + * in the bitmap. + * * All ptes dirtied after that will either remain dirty, be recorded in the + * bitmap or both. * * If a caller needs to make sure all dirty ptes are picked up and none * additional are added, it first needs to write-protect the address-space
Turn the a), b) into an unordered ReST list and remove the unnecessary 'Note:' prefix. Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org> --- mm/mapping_dirty_helpers.c | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-)