From 3094caa2bec304967da9facd8e67849c9c1b5b42 Mon Sep 17 00:00:00 2001 From: Scott Register Date: Thu, 2 Oct 2025 09:08:31 -0700 Subject: [PATCH] Fix readme formatting The implemented functions markdown wasn't formatted correctly and was causing all the text to be in one big block, this makes it easier to read now on github.com Signed-off-by: Scott Register --- README.md | 52 +++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 39 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 0c97919..4df4322 100644 --- a/README.md +++ b/README.md @@ -18,19 +18,45 @@ print(dmesg_obj.get_os_package_info()) ## Implemented methods -`check_if_available(self) -> None` - responsible to check if tool is available in system. -`get_version(self) -> str` - responsible to get version of tool. -`get_messages(self, level: DmesgLevelOptions = DmesgLevelOptions.NONE, service_name: str = None) -> str` - responsible to return dmesg output will take service name, level of the dmesg contents and name as optional parameters. -`get_buffer_size_data(self, driver_name: str, driver_interface_number: str) -> Optional[list]` - responsible to return buffer size for respective drivername and interface number. -`get_os_package_info(self) -> Union[OSPackageInfo, None]` - responsible to return os package installed which is retrived from dmesg output. -`get_messages_additional(self, service_name: str = None, lines: int = 1000, expected_return_codes: Iterable = frozenset({0}), additional_greps: Optional[List[str]] = None) -> str` - responsible to return latest dmesg output based on addtional filters as specified by the user. -`verify_messages(self) -> dict` - responsible to check if there are err level messages in dmesg output. -`clear_messages(self, errors_filter: Optional[List[str]] = [], ignore_filter: Optional[List[str]] = [],) -> Tuple[str, List[str]]` - responsible to clear the message buffer of the kernel (dmesg). -`clear_messages_after_error(self, error_msg: str) -> Union[Tuple[str, List[str]], None]` - responsible to clear the message buffer of the kernel (dmesg) after user defined error occurred. -`check_errors(self, error_list: list) -> tuple` - responsible to check for the errors as specified by the user list or user can select from predefined list declared in constant file. -`check_str_present(self, service_name: str, lookout_str: str, additional_greps: Optional[List[str]] = None) -> bool` - responsible to check for particular user defined string in dmesg output. -`check_messages_format(self, driver: str, time_format: str = "%Y-%m-%dT%H:%M:%S.%fZ") -> Union[bool, None]` - responsible to check for userdefined time format or default time format in dmesg logs. -`check_new_errors(self) -> dict` - responsible to check for new errors in dmesg output apart from last time the dmesg log collected. +- `check_if_available(self) -> None` + + Responsible to check if tool is available in system. +- `get_version(self) -> str` + + Responsible to get version of tool. +- `get_messages(self, level: DmesgLevelOptions = DmesgLevelOptions.NONE, service_name: str = None) -> str` + + Responsible to return dmesg output using optional service name and level parameters. +- `get_buffer_size_data(self, driver_name: str, driver_interface_number: str) -> Optional[list]` + + Responsible to return buffer size for respective driver name and interface number. +- `get_os_package_info(self) -> Union[OSPackageInfo, None]` + + Responsible to return OS package installed which is retrieved from dmesg output. +- `get_messages_additional(self, service_name: str = None, lines: int = 1000, expected_return_codes: Iterable = frozenset({0}), additional_greps: Optional[List[str]] = None) -> str` + + Responsible to return latest dmesg output based on additional filters as specified by the user. +- `verify_messages(self) -> dict` + + Responsible to check if there are err level messages in dmesg output. +- `clear_messages(self, errors_filter: Optional[List[str]] = [], ignore_filter: Optional[List[str]] = [],) -> Tuple[str, List[str]]` + + Responsible to clear the message buffer of the kernel (dmesg). +- `clear_messages_after_error(self, error_msg: str) -> Union[Tuple[str, List[str]], None]` + + Responsible to clear the message buffer of the kernel (dmesg) after user defined error occurred. +- `check_errors(self, error_list: list) -> tuple` + + Responsible to check for the errors as specified by the user list or user can select from predefined list declared in constant file. +- `check_str_present(self, service_name: str, lookout_str: str, additional_greps: Optional[List[str]] = None) -> bool` + + Responsible to check for particular user defined string in dmesg output. +- `check_messages_format(self, driver: str, time_format: str = "%Y-%m-%dT%H:%M:%S.%fZ") -> Union[bool, None]` + + Responsible to check for user defined time format or default time format in dmesg logs. +- `check_new_errors(self) -> dict` + + Responsible to check for new errors in dmesg output apart from last time the dmesg log collected. **Methods** - `verify_log(driver: str) -> str`