liblognorm icon indicating copy to clipboard operation
liblognorm copied to clipboard

Little disambiguity in description(comments) of liblognorm.h/ln_loadSamples function()

Open rajeshksv opened this issue 7 years ago • 0 comments

In ln_loadSamples() function, comments say "load a log sample file". Its a bit ambiguous - if log sample file is a rules file or logs file. But for next ln_loadSamplesFromString() function, it clearly says loads rulebase from a string. Saying load a rule base file may be less ambiguous for ln_loadSamples.

/**

  • Load a (log) sample file.
  • The file must contain log samples in syntactically correct format. Samples are added
  • to set already loaded in the current context. If there is a sample with duplicate
  • semantics, this sample will be ignored. Most importantly, this can \b not be used
  • to change tag assignments for a given sample.
  • @param[in] ctx The library context to apply callback to.
  • @param[in] file Name of file to be loaded.
  • @return Returns zero on success, something else otherwise. */ int ln_loadSamples(ln_ctx ctx, const char *file);

/**

  • Load a rulebase via a string. */ int ln_loadSamplesFromString(ln_ctx ctx, const char *string);

rajeshksv avatar Jun 27 '17 14:06 rajeshksv