earlycpio.c: Fix the confusing comment of find_cpio_data().
authorTang Chen <tangchen@cn.fujitsu.com>
Wed, 14 Aug 2013 09:37:07 +0000 (17:37 +0800)
committerRafael J. Wysocki <rafael.j.wysocki@intel.com>
Wed, 14 Aug 2013 21:24:01 +0000 (23:24 +0200)
commit598bae70c2a8e35c8d39b610cca2b32afcf047af
treee0e49b046357dc1e6aecd69e4ee0fd9a7f9e456c
parentd7b2c3d8fb6f53a370696572ef3578a7f8723147
earlycpio.c: Fix the confusing comment of find_cpio_data().

The comments of find_cpio_data() says:

  * @offset: When a matching file is found, this is the offset to the
  *          beginning of the cpio. ......

But according to the code,

  dptr = PTR_ALIGN(p + ch[C_NAMESIZE], 4);
  nptr = PTR_ALIGN(dptr + ch[C_FILESIZE], 4);
  ....
  *offset = (long)nptr - (long)data; /* data is the cpio file */

@offset is the offset of the next file, not the matching file itself.
This is confused and may cause unnecessary waste of time to debug.
So fix it.

As Tejun Heo suggested, rename @offset to @nextoff which is more clear
to users. And also adjust the new comments.

Signed-off-by: Tang Chen <tangchen@cn.fujitsu.com>
Reviewed-by: Zhang Yanfei <zhangyanfei@cn.fujitsu.com>
Reviewed-by: Tejun Heo <tj@kernel.org>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
lib/earlycpio.c