diff mbox series

doc: update release note for hash library

Message ID 1539715652-101433-1-git-send-email-yipeng1.wang@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series doc: update release note for hash library | expand

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Wang, Yipeng1 Oct. 16, 2018, 6:47 p.m. UTC
This patch updates release note for the new extendable bucket
feature and the partial-key hashing.

Signed-off-by: Yipeng Wang <yipeng1.wang@intel.com>
---
 doc/guides/rel_notes/release_18_11.rst | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Honnappa Nagarahalli Oct. 17, 2018, 8:09 p.m. UTC | #1
> 
> This patch updates release note for the new extendable bucket feature and
> the partial-key hashing.
> 
> Signed-off-by: Yipeng Wang <yipeng1.wang@intel.com>
> ---
>  doc/guides/rel_notes/release_18_11.rst | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/release_18_11.rst
> b/doc/guides/rel_notes/release_18_11.rst
> index c13ea82..95c218d 100644
> --- a/doc/guides/rel_notes/release_18_11.rst
> +++ b/doc/guides/rel_notes/release_18_11.rst
> @@ -164,6 +164,13 @@ New Features
>    this application doesn't need to launch dedicated worker threads for vhost
>    enqueue/dequeue operations.
> 
> +* **Added extendable bucket feature to hash library (rte_hash).**
> +
> +  This new “extendable bucket” feature provides 100% insertion
> + guarantee to  the capacity specified by the user by extending hash
> + table with extra  buckets when needed to accommodate the unlikely
> + event of intensive hash  collisions.  In addition, the internal
> + hashing algorithm was changed to use  partial-key hashing to improve
Do we need to provide the reference to partial-key hashing paper?

> memory efficiency and lookup performance.
> 
>  API Changes
>  -----------
> --
> 2.7.4
Other than the above comment, looks fine.
Compiled and verified
Acked-by: Honnappa Nagarahalli <Honnappa.nagarahalli@arm.com>
Wang, Yipeng1 Oct. 25, 2018, 6:45 p.m. UTC | #2
> -----Original Message-----
> From: Honnappa Nagarahalli [mailto:Honnappa.Nagarahalli@arm.com]
> >
> > +* **Added extendable bucket feature to hash library (rte_hash).**
> > +
> > +  This new “extendable bucket” feature provides 100% insertion
> > + guarantee to  the capacity specified by the user by extending hash
> > + table with extra  buckets when needed to accommodate the unlikely
> > + event of intensive hash  collisions.  In addition, the internal
> > + hashing algorithm was changed to use  partial-key hashing to improve
> Do we need to provide the reference to partial-key hashing paper?
> 
[Wang, Yipeng] Sorry for the delay, I thought I replied...

I assumed it should be a 1-2 sentence summary so I did not include the citation.

@John, do you think it is good to include reference here? The original idea is from a paper which
I referenced in the source code comments and commit message.

> > memory efficiency and lookup performance.
> >
> >  API Changes
> >  -----------
> > --
> > 2.7.4
> Other than the above comment, looks fine.
> Compiled and verified
> Acked-by: Honnappa Nagarahalli <Honnappa.nagarahalli@arm.com>
Thomas Monjalon Oct. 25, 2018, 11:07 p.m. UTC | #3
25/10/2018 20:45, Wang, Yipeng1:
> > -----Original Message-----
> > From: Honnappa Nagarahalli [mailto:Honnappa.Nagarahalli@arm.com]
> > >
> > > +* **Added extendable bucket feature to hash library (rte_hash).**
> > > +
> > > +  This new “extendable bucket” feature provides 100% insertion
> > > + guarantee to  the capacity specified by the user by extending hash
> > > + table with extra  buckets when needed to accommodate the unlikely
> > > + event of intensive hash  collisions.  In addition, the internal
> > > + hashing algorithm was changed to use  partial-key hashing to improve
> > Do we need to provide the reference to partial-key hashing paper?
> > 
> [Wang, Yipeng] Sorry for the delay, I thought I replied...
> 
> I assumed it should be a 1-2 sentence summary so I did not include the citation.
> 
> @John, do you think it is good to include reference here? The original idea is from a paper which
> I referenced in the source code comments and commit message.

It's really better when release notes are updated in the same patch
as the code. I have inserted it in your patches when applying them.

I think the citation is not so important in the release notes.
diff mbox series

Patch

diff --git a/doc/guides/rel_notes/release_18_11.rst b/doc/guides/rel_notes/release_18_11.rst
index c13ea82..95c218d 100644
--- a/doc/guides/rel_notes/release_18_11.rst
+++ b/doc/guides/rel_notes/release_18_11.rst
@@ -164,6 +164,13 @@  New Features
   this application doesn't need to launch dedicated worker threads for vhost
   enqueue/dequeue operations.
 
+* **Added extendable bucket feature to hash library (rte_hash).**
+
+  This new “extendable bucket” feature provides 100% insertion guarantee to
+  the capacity specified by the user by extending hash table with extra
+  buckets when needed to accommodate the unlikely event of intensive hash
+  collisions.  In addition, the internal hashing algorithm was changed to use
+  partial-key hashing to improve memory efficiency and lookup performance.
 
 API Changes
 -----------