Skip to content

Commit ea5048a

Browse files
committed
Unified the kernel option names in the ZSwapObject class.
1 parent bf31826 commit ea5048a

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

src/lib/zswapobject/zswapobject.hpp

+26-26
Original file line numberDiff line numberDiff line change
@@ -140,101 +140,101 @@ class ZSwapObject
140140
bool IsAvailable() const;
141141
private:
142142
/**
143-
* Stores the ZSwap kernel module parameters path.
143+
* Stores the ZSwap kernel module options path.
144144
*/
145145
const std::string ZSwapModuleParametersPath = "/sys/module/zswap/parameters/";
146146

147147
/**
148-
* Stores the ZSwap enabled internal parameter name.
148+
* Stores the ZSwap enabled internal option name.
149149
*/
150150
const std::string ZSwapEnabledName = "enabled";
151151

152152
/**
153-
* Stores the same filled pages enabled internal parameter name.
153+
* Stores the same filled pages enabled internal option name.
154154
*/
155155
const std::string ZSwapSameFilledPagesName = "same_filled_pages_enabled";
156156

157157
/**
158-
* Stores the maximum pool percentage internal parameter name.
158+
* Stores the maximum pool percentage internal option name.
159159
*/
160160
const std::string ZSwapMaxPoolPercentName = "max_pool_percent";
161161

162162
/**
163-
* Stores the compression algorithm internal parameter name.
163+
* Stores the compression algorithm internal option name.
164164
*/
165165
const std::string ZSwapCompressorName = "compressor";
166166

167167
/**
168-
* Stores the kernel's zpool type internal parameter name.
168+
* Stores the kernel's zpool type internal option name.
169169
*/
170170
const std::string ZSwapZpoolName = "zpool";
171171

172172
/**
173-
* Stores the accept threshold percentage internal parameter name.
173+
* Stores the accept threshold percentage internal option name.
174174
*/
175175
const std::string ZSwapAcceptThresholdPercentName = "accept_threshold_percent";
176176

177177
/**
178-
* Stores the non same filled pages enabled internal parameter name.
178+
* Stores the non same filled pages enabled internal option name.
179179
*/
180180
const std::string ZSwapNonSameFilledPagesName = "non_same_filled_pages_enabled";
181181

182182
/**
183-
* Stores the exclusive loads enabled internal parameter name.
183+
* Stores the exclusive loads enabled internal option name.
184184
*/
185185
const std::string ZSwapExclusiveLoadsName = "exclusive_loads";
186186

187187
/**
188-
* Stores the shrinker enabled internal parameter name.
188+
* Stores the shrinker enabled internal option name.
189189
*/
190190
const std::string ZSwapShrinkerEnabledName = "shrinker_enabled";
191191

192192
/**
193-
* Writes a new value to the specified ZSwap kernel module variable.
194-
* @param Name Variable name.
195-
* @param Value Variable value.
193+
* Writes a new value to the specified ZSwap kernel module option.
194+
* @param Name Option name.
195+
* @param Value Option value.
196196
* @exception Raises an instance of std::runtime_error if the kernel
197-
* module variable is not available.
197+
* module option is not available.
198198
*/
199199
void WriteZSwapValue(const std::string&, const std::string&) const;
200200

201201
/**
202-
* Reads the value of the ZSwap kernel module variable by the specified
203-
* name.
204-
* @param Name Variable name.
205-
* @returns Variable value or N/A if not available.
202+
* Reads the value of the ZSwap kernel module option by the
203+
* specified name.
204+
* @param Name Option name.
205+
* @returns Option value or N/A if not available.
206206
*/
207207
std::string ReadZSwapValue(const std::string&) const;
208208

209209
/**
210210
* Prints the log entry to the standard output.
211-
* @param Name Variable name.
212-
* @param Value Variable value.
211+
* @param Name Option name.
212+
* @param Value Option value.
213213
*/
214214
void WriteLogEntry(const std::string&, const std::string&) const;
215215

216216
/**
217217
* Checks if the value is Y or N.
218-
* @param Name Variable name.
219-
* @param Value Variable value to check.
218+
* @param Name Option name.
219+
* @param Value Option value to check.
220220
* @exception Raises an instance of std::invalid_argument if the
221221
* value does not meet the criteria.
222222
*/
223223
void CheckValueBool(const std::string&, const std::string&) const;
224224

225225
/**
226226
* Checks if the value is empty.
227-
* @param Name Variable name.
228-
* @param Value Variable value to check.
227+
* @param Name Option name.
228+
* @param Value Option value to check.
229229
* @exception Raises an instance of std::invalid_argument if the
230230
* value does not meet the criteria.
231231
*/
232232
void CheckValueEmpty(const std::string&, const std::string&) const;
233233

234234
/**
235235
* Checks if the value is in the [0..100] range.
236-
* @param Name Variable name.
237-
* @param Value Variable value to check.
236+
* @param Name Option name.
237+
* @param Value Option value to check.
238238
* @exception Raises an instance of std::invalid_argument if the
239239
* value does not meet the criteria.
240240
*/

0 commit comments

Comments
 (0)