Docs for error codes Prefix Categories

[DuanKuanJun]

Description

Please briefly describe the code changes in this pull request.

Checklist

Please check the items in the checklist if applicable.

• Is the user manual updated?
• Are the test cases passed and automated?
• Is there no significant decrease in test coverage?

[gemini-code-assist]

Summary of Changes

Hello @DuanKuanJun, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly improves the clarity and comprehensiveness of the TDengine error code documentation. By introducing a structured explanation of error code formats and categorizing them by their origin (TDengine business logic or underlying operating system calls), users will now have a much easier time understanding, diagnosing, and resolving issues indicated by error codes. This update applies to both English and Chinese versions of the documentation.

Highlights

• Enhanced Error Code Documentation: A new section has been added to the error code reference documentation, providing a detailed explanation of the structure and categorization of TDengine error codes.
• Error Code Structure Explained: The documentation now clarifies that error codes are 8-digit hexadecimal numbers, composed of a 4-digit Category Prefix and a 4-digit Specific Error Code.
• Detailed Prefix Categories: New prefix categories have been introduced, distinguishing between TDengine TSDB Business Errors, Linux System Call Errors, Windows API System Errors, and Windows Socket System Errors, complete with their respective hexadecimal prefixes and links to external documentation for system errors.
• Illustrative Examples: Concrete examples are provided to demonstrate how to interpret error codes, such as 0x80000216 for a TDengine business error and 0x80FF0002 for a Linux system error, making the explanation clearer for users.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request significantly improves the error code documentation by adding a clear structure for error codes, including prefix categories and examples. This will be very helpful for users. My review includes suggestions to improve the clarity of the links provided for external error code references, ensuring the link text accurately reflects the content of the linked page.