| Message ID | 20190911030856.18010-1-caoj.fnst@cn.fujitsu.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | mm/memblock: fix typo in memblock doc | expand |
On Wed, Sep 11, 2019 at 11:08:56AM +0800, Cao jin wrote: > elaboarte -> elaborate > architecure -> architecture > compltes -> completes > > Signed-off-by: Cao jin <caoj.fnst@cn.fujitsu.com> > --- > mm/memblock.c | 6 +++--- > 1 file changed, 3 insertions(+), 3 deletions(-) > > diff --git a/mm/memblock.c b/mm/memblock.c > index 7d4f61ae666a..0d0f92003d18 100644 > --- a/mm/memblock.c > +++ b/mm/memblock.c > @@ -83,16 +83,16 @@ > * Note, that both API variants use implict assumptions about allowed > * memory ranges and the fallback methods. Consult the documentation > * of :c:func:`memblock_alloc_internal` and > - * :c:func:`memblock_alloc_range_nid` functions for more elaboarte > + * :c:func:`memblock_alloc_range_nid` functions for more elaborate While on it, could you please replace the :c:func:`memblock_alloc_range_nid` construct with memblock_alloc_range_nid()? And that would be really great to see all the :c:func:`foo` changed to foo(). > * description. > * > * As the system boot progresses, the architecture specific > * :c:func:`mem_init` function frees all the memory to the buddy page > * allocator. > * > - * Unless an architecure enables %CONFIG_ARCH_KEEP_MEMBLOCK, the > + * Unless an architecture enables %CONFIG_ARCH_KEEP_MEMBLOCK, the > * memblock data structures will be discarded after the system > - * initialization compltes. > + * initialization completes. > */ > > #ifndef CONFIG_NEED_MULTIPLE_NODES > -- > 2.21.0 > > >
On 9/11/19 10:42 PM, Mike Rapoport wrote: > On Wed, Sep 11, 2019 at 11:08:56AM +0800, Cao jin wrote: >> elaboarte -> elaborate >> architecure -> architecture >> compltes -> completes >> >> Signed-off-by: Cao jin <caoj.fnst@cn.fujitsu.com> >> --- >> mm/memblock.c | 6 +++--- >> 1 file changed, 3 insertions(+), 3 deletions(-) >> >> diff --git a/mm/memblock.c b/mm/memblock.c >> index 7d4f61ae666a..0d0f92003d18 100644 >> --- a/mm/memblock.c >> +++ b/mm/memblock.c >> @@ -83,16 +83,16 @@ >> * Note, that both API variants use implict assumptions about allowed >> * memory ranges and the fallback methods. Consult the documentation >> * of :c:func:`memblock_alloc_internal` and >> - * :c:func:`memblock_alloc_range_nid` functions for more elaboarte >> + * :c:func:`memblock_alloc_range_nid` functions for more elaborate > > While on it, could you please replace the > :c:func:`memblock_alloc_range_nid` construct with > memblock_alloc_range_nid()? > > And that would be really great to see all the :c:func:`foo` changed to > foo(). > Sure. BTW, do you want convert all the markups too? :c:type:`foo` -> struct foo %FOO -> FOO ``foo`` -> foo **foo** -> foo
On Thu, Sep 12, 2019 at 10:54:09AM +0800, Cao jin wrote: > On 9/11/19 10:42 PM, Mike Rapoport wrote: > > On Wed, Sep 11, 2019 at 11:08:56AM +0800, Cao jin wrote: > >> elaboarte -> elaborate > >> architecure -> architecture > >> compltes -> completes > >> > >> Signed-off-by: Cao jin <caoj.fnst@cn.fujitsu.com> > >> --- > >> mm/memblock.c | 6 +++--- > >> 1 file changed, 3 insertions(+), 3 deletions(-) > >> > >> diff --git a/mm/memblock.c b/mm/memblock.c > >> index 7d4f61ae666a..0d0f92003d18 100644 > >> --- a/mm/memblock.c > >> +++ b/mm/memblock.c > >> @@ -83,16 +83,16 @@ > >> * Note, that both API variants use implict assumptions about allowed > >> * memory ranges and the fallback methods. Consult the documentation > >> * of :c:func:`memblock_alloc_internal` and > >> - * :c:func:`memblock_alloc_range_nid` functions for more elaboarte > >> + * :c:func:`memblock_alloc_range_nid` functions for more elaborate > > > > While on it, could you please replace the > > :c:func:`memblock_alloc_range_nid` construct with > > memblock_alloc_range_nid()? > > > > And that would be really great to see all the :c:func:`foo` changed to > > foo(). > > > > Sure. BTW, do you want convert all the markups too? > > :c:type:`foo` -> struct foo > %FOO -> FOO > ``foo`` -> foo > **foo** -> foo The documentation toolchain can recognize now foo() as a function and does not require the :c:func: prefix for that. AFAIK it only works for functions, so please don't change the rest of the markup. > -- > Sincerely, > Cao jin > >
On 9/12/19 6:35 PM, Mike Rapoport wrote: > On Thu, Sep 12, 2019 at 10:54:09AM +0800, Cao jin wrote: >> On 9/11/19 10:42 PM, Mike Rapoport wrote: >> >> Sure. BTW, do you want convert all the markups too? >> >> :c:type:`foo` -> struct foo >> %FOO -> FOO >> ``foo`` -> foo >> **foo** -> foo > > The documentation toolchain can recognize now foo() as a function and does > not require the :c:func: prefix for that. AFAIK it only works for > functions, so please don't change the rest of the markup. > I see. Thanks for the info. Patch on the way.
diff --git a/mm/memblock.c b/mm/memblock.c index 7d4f61ae666a..0d0f92003d18 100644 --- a/mm/memblock.c +++ b/mm/memblock.c @@ -83,16 +83,16 @@ * Note, that both API variants use implict assumptions about allowed * memory ranges and the fallback methods. Consult the documentation * of :c:func:`memblock_alloc_internal` and - * :c:func:`memblock_alloc_range_nid` functions for more elaboarte + * :c:func:`memblock_alloc_range_nid` functions for more elaborate * description. * * As the system boot progresses, the architecture specific * :c:func:`mem_init` function frees all the memory to the buddy page * allocator. * - * Unless an architecure enables %CONFIG_ARCH_KEEP_MEMBLOCK, the + * Unless an architecture enables %CONFIG_ARCH_KEEP_MEMBLOCK, the * memblock data structures will be discarded after the system - * initialization compltes. + * initialization completes. */ #ifndef CONFIG_NEED_MULTIPLE_NODES
elaboarte -> elaborate architecure -> architecture compltes -> completes Signed-off-by: Cao jin <caoj.fnst@cn.fujitsu.com> --- mm/memblock.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)