118. ModulesComments

Library for handling special comments in /etc/modules.conf

118.1. Summary of Module Globals

List of Global Functions

ExtractFromComment - Extacts the unique key and the name of the card from comment in the modules.conf placed before the alias differentiatin the card.
StoreToComment - Create comment for modules.conf from the unique key and the name of the card. It will be parsed when reading. This comment should be placed before the alias differentiating the card (char-major-81-x for TV cards, ethx for ethernet, ...)

List of Global Variables

118.2. Global Functions

118.2.1. ExtractFromComment

Extacts the unique key and the name of the card from comment in the modules.conf placed before the alias differentiatin the card.

Function parameters

string comment

Return value

map - Returns map: $[ "unique_key" : string, "name" : string ]

Example 10.

    ModulesComments::ExtractFromComment ("# xyza.aiLKJkjsdlj:Ultra brutal TV card\n")
 -> $[ "name" : "Ultra brutal TV card", "unique_key" : "xyza.aiLKJkjsdlj" ]

118.2.2. StoreToComment

Create comment for modules.conf from the unique key and the name of the card. It will be parsed when reading. This comment should be placed before the alias differentiating the card (char-major-81-x for TV cards, ethx for ethernet, ...)

Function parameters

string name
string unique_key

Return value

string - The comment.

Example 11.

    ModulesComments::StoreToComment ("Ultra brutal TV card", "xyza.aiLKJkjsdlj")
 -> "# xyza.aiLKJkjsdlj:Ultra brutal TV card\n"

118.3. Global Variables

118.4. Module Requirements

none


117. ModuleLoading		119. ModulesConf