mbox series

[00/10] Docs/mm/damon: Minor fixes and design doc update

Message ID 20230525214314.5204-1-sj@kernel.org (mailing list archive)
Headers show
Series Docs/mm/damon: Minor fixes and design doc update | expand

Message

SeongJae Park May 25, 2023, 9:43 p.m. UTC
Some of DAMON documents are outdated, or having minor typos or grammar
erros.  Especially, the design doc has not updated for DAMOS, which is
an important part of DAMON.  Fix the minor issues and update documents.

SeongJae Park (10):
  Docs/mm/damon/faq: remove old questions
  Docs/mm/damon/maintainer-profile: fix typos and grammar errors
  Docs/mm/damon/design: add a section for overall architecture
  Docs/mm/damon/design: update the layout based on the layers
  Docs/mm/damon/design: rewrite configurable layers
  Docs/mm/damon/design: add a section for the relation between Core and
    Modules layer
  Docs/mm/damon/design: add sections for basic parts of DAMOS
  Docs/mm/damon/design: add sections for advanced features of DAMOS
  Docs/mm/damon/design: add a section for DAMON core API
  Docs/mm/damon/design: add a section for the modules layer

 Documentation/mm/damon/design.rst             | 309 ++++++++++++++++--
 Documentation/mm/damon/faq.rst                |  23 --
 Documentation/mm/damon/maintainer-profile.rst |   4 +-
 3 files changed, 285 insertions(+), 51 deletions(-)

Comments

SeongJae Park May 26, 2023, 9:14 p.m. UTC | #1
On Thu, 25 May 2023 21:43:04 +0000 SeongJae Park <sj@kernel.org> wrote:

> Some of DAMON documents are outdated, or having minor typos or grammar
> erros.  Especially, the design doc has not updated for DAMOS, which is
> an important part of DAMON.  Fix the minor issues and update documents.

By the way, I started writing this patchset before LSFMM, but Michal's feedback
about DAMON documentation has definitely motivated this work, and was helpful.
Thank you, Michal.  I just wanted to say that.  Of course, more documentation
improvement works will be continued.


Thanks,
SJ

> 
> SeongJae Park (10):
>   Docs/mm/damon/faq: remove old questions
>   Docs/mm/damon/maintainer-profile: fix typos and grammar errors
>   Docs/mm/damon/design: add a section for overall architecture
>   Docs/mm/damon/design: update the layout based on the layers
>   Docs/mm/damon/design: rewrite configurable layers
>   Docs/mm/damon/design: add a section for the relation between Core and
>     Modules layer
>   Docs/mm/damon/design: add sections for basic parts of DAMOS
>   Docs/mm/damon/design: add sections for advanced features of DAMOS
>   Docs/mm/damon/design: add a section for DAMON core API
>   Docs/mm/damon/design: add a section for the modules layer
> 
>  Documentation/mm/damon/design.rst             | 309 ++++++++++++++++--
>  Documentation/mm/damon/faq.rst                |  23 --
>  Documentation/mm/damon/maintainer-profile.rst |   4 +-
>  3 files changed, 285 insertions(+), 51 deletions(-)
> 
> -- 
> 2.25.1
>