diff --git a/docs/introduction/intro.md b/docs/introduction/intro.md index 5f361909..59834167 100644 --- a/docs/introduction/intro.md +++ b/docs/introduction/intro.md @@ -1,3 +1,3 @@ # DragonOS简介 -DragonOS龙操作系统(以下简称“DragonOS”)是一个基于x86-64体系结构开发的,基于GPLv2协议开放源代码的64位操作系统。 \ No newline at end of file +DragonOS龙操作系统(以下简称“DragonOS”)是一个基于x86-64体系结构开发的,基于GPLv2协议开放源代码的64位操作系统。 diff --git a/docs/userland/libc/apis/api-list/.vscode/settings.json b/docs/userland/libc/apis/api-list/.vscode/settings.json new file mode 100644 index 00000000..73dc9f31 --- /dev/null +++ b/docs/userland/libc/apis/api-list/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "restructuredtext.preview.name": "docutils" +} \ No newline at end of file diff --git a/docs/userland/libc/apis/api-list/ctype.rst b/docs/userland/libc/apis/api-list/ctype.md similarity index 85% rename from docs/userland/libc/apis/api-list/ctype.rst rename to docs/userland/libc/apis/api-list/ctype.md index 2a1c5c4e..35cb3725 100644 --- a/docs/userland/libc/apis/api-list/ctype.rst +++ b/docs/userland/libc/apis/api-list/ctype.md @@ -1,7 +1,5 @@ -ctype.h -==================================== -函数列表(这里只列出已实现的函数): - ==== +# ctype.h +## 函数列表(这里只列出已实现的函数): ``int isprint(int c)`` : 传入一个字符,判断是否可以被输出 @@ -19,10 +17,9 @@ ctype.h ``int isspace(int c)`` : 传入一个字符,判断是否是空白字符 -宏定义: - ==== +## 宏定义: - 暂无用处 + ### 暂无用处 ``#define _U 01`` diff --git a/docs/userland/libc/apis/api-list/dirent.rst b/docs/userland/libc/apis/api-list/dirent.md similarity index 84% rename from docs/userland/libc/apis/api-list/dirent.rst rename to docs/userland/libc/apis/api-list/dirent.md index e0cb0f0c..58f02731 100644 --- a/docs/userland/libc/apis/api-list/dirent.rst +++ b/docs/userland/libc/apis/api-list/dirent.md @@ -1,11 +1,8 @@ -dirent.h -==================================== -简介 - ==== +# dirent.h +## 简介 与文件夹有关的头文件。 -结构体列表: - =========================== +## 结构体列表: ``struct DIR`` : @@ -31,8 +28,7 @@ dirent.h ``char d_name[]`` : 目标的名字 -函数列表(这里只列出已实现的函数): - =========================== +## 函数列表(这里只列出已实现的函数): ``DIR opendir(const char *path)`` @@ -48,8 +44,7 @@ dirent.h 传入文件夹结构体,读入文件夹里的内容,并打包为dirent结构体返回 -宏定义: - =========================== +## 宏定义: 文件夹类型: diff --git a/docs/userland/libc/apis/api-list/errno.rst b/docs/userland/libc/apis/api-list/errno.md similarity index 97% rename from docs/userland/libc/apis/api-list/errno.rst rename to docs/userland/libc/apis/api-list/errno.md index d2cba82c..017c7450 100644 --- a/docs/userland/libc/apis/api-list/errno.rst +++ b/docs/userland/libc/apis/api-list/errno.md @@ -1,13 +1,14 @@ -errno.h -==================================== -简介: - =========== +# errno.h + +## 简介: + 共享错误号码 -属性: - =========== +## 属性: + ``extern int errno`` : 通用错误代码 -宏定义(复制自代码,了解即可): - =========== + +## 宏定义(复制自代码,了解即可): + #define E2BIG 1 /* 参数列表过长,或者在输出buffer中缺少空间 或者参数比系统内建的最大值要大 Argument list too long.*/ #define EACCES 2 /* 访问被拒绝 Permission denied*/ diff --git a/docs/userland/libc/apis/api-list/fcntl.rst b/docs/userland/libc/apis/api-list/fcntl.md similarity index 88% rename from docs/userland/libc/apis/api-list/fcntl.rst rename to docs/userland/libc/apis/api-list/fcntl.md index c6967a43..3c8cb6dd 100644 --- a/docs/userland/libc/apis/api-list/fcntl.rst +++ b/docs/userland/libc/apis/api-list/fcntl.md @@ -1,16 +1,16 @@ -fcntl.h -==================================== -简介 - ======== +# fcntl.h + +## 简介 + 文件操作 -函数列表: - ======== +## 函数列表: + ``int open(const char * path,int options, ...)`` 传入文件路径,和文件类型(详细请看下面的宏定义),将文件打开并返回文件id。 -宏定义(粘贴自代码,了解即可): - ======== +## 宏定义(粘贴自代码,了解即可): + #define O_RDONLY 00000000 // Open Read-only #define O_WRONLY 00000001 // Open Write-only diff --git a/docs/userland/libc/apis/api-list/math.rst b/docs/userland/libc/apis/api-list/math.md similarity index 83% rename from docs/userland/libc/apis/api-list/math.rst rename to docs/userland/libc/apis/api-list/math.md index 74f763a9..69abc25d 100644 --- a/docs/userland/libc/apis/api-list/math.rst +++ b/docs/userland/libc/apis/api-list/math.md @@ -1,10 +1,11 @@ -math.h -==================================== -简介: - ====== +# math.h + +## 简介: + 数学库 -函数列表: +## 函数列表: + ``double fabs(double x)`` : 返回 x 的绝对值 ``float fabsf(float x)`` : 返回 x 的绝对值 diff --git a/docs/userland/libc/apis/api-list/printf.rst b/docs/userland/libc/apis/api-list/printf.md similarity index 58% rename from docs/userland/libc/apis/api-list/printf.rst rename to docs/userland/libc/apis/api-list/printf.md index eb6e4cd3..04103add 100644 --- a/docs/userland/libc/apis/api-list/printf.rst +++ b/docs/userland/libc/apis/api-list/printf.md @@ -1,3 +1,3 @@ -printf.h -==================================== +# printf.h + 不建议引用,需要 ``printf`` 函数请引用 ``stdio.h`` \ No newline at end of file diff --git a/docs/userland/libc/apis/api-list/stddef.rst b/docs/userland/libc/apis/api-list/stddef.md similarity index 64% rename from docs/userland/libc/apis/api-list/stddef.rst rename to docs/userland/libc/apis/api-list/stddef.md index d9dad7c5..b9c445ad 100644 --- a/docs/userland/libc/apis/api-list/stddef.rst +++ b/docs/userland/libc/apis/api-list/stddef.md @@ -1,11 +1,11 @@ -stddef.h -==================================== -简介: - ====== +# stddef.h + +## 简介: + 定义了关于指针的常用类型 -定义: - ===== +## 定义: + ``typedef __PTDIFF_TYPE__ ptrdiff_t`` : 两个指针相减的结果类型 ``NULL ((void *) 0)`` : 空指针 \ No newline at end of file diff --git a/docs/userland/libc/apis/api-list/stdio.rst b/docs/userland/libc/apis/api-list/stdio.md similarity index 86% rename from docs/userland/libc/apis/api-list/stdio.rst rename to docs/userland/libc/apis/api-list/stdio.md index c75910f1..becd2039 100644 --- a/docs/userland/libc/apis/api-list/stdio.rst +++ b/docs/userland/libc/apis/api-list/stdio.md @@ -1,10 +1,10 @@ -stdio.h -==================================== -简介: - ======= +# stdio.h + +## 简介: + 向标准输入输出里操作 -函数列表: - ====== +## 函数列表: + ``int64_t put_string(char *str, uint64_t front_color, uint64_t bg_color)`` 输出字符串(带有前景色,背景色) @@ -20,10 +20,10 @@ stdio.h ``int vsprintf(char *buf,const char *fmt,va_list args)`` 格式化,不建议调用,请用 printf 或 sprintf 替代。 -宏定义 - ======= - 字体颜色的宏定义 - ========= +## 宏定义 + + ### 字体颜色的宏定义 + ``#define COLOR_WHITE 0x00ffffff //白`` ``#define COLOR_BLACK 0x00000000 //黑`` @@ -41,8 +41,8 @@ stdio.h ``#define COLOR_INDIGO 0x0000ffff //靛`` ``#define COLOR_PURPLE 0x008000ff //紫`` - 无需使用 - ======= + ### 无需使用 + ``#define SEEK_SET 0 /* Seek relative to start-of-file */`` ``#define SEEK_CUR 1 /* Seek relative to current position */`` diff --git a/docs/userland/libc/apis/api-list/stdlib.rst b/docs/userland/libc/apis/api-list/stdlib.md similarity index 80% rename from docs/userland/libc/apis/api-list/stdlib.rst rename to docs/userland/libc/apis/api-list/stdlib.md index 38b95185..afa75093 100644 --- a/docs/userland/libc/apis/api-list/stdlib.rst +++ b/docs/userland/libc/apis/api-list/stdlib.md @@ -1,10 +1,10 @@ -stdlib.h -==================================== -简介: - ===== +# stdlib.h + +## 简介: + 一些常用函数 -函数列表: - ====== +## 函数列表: + ``void *malloc(ssize_t size)`` : 普通的 ``malloc`` ``void free(void *ptr)`` : 释放内存 diff --git a/docs/userland/libc/apis/api-list/string.rst b/docs/userland/libc/apis/api-list/string.md similarity index 85% rename from docs/userland/libc/apis/api-list/string.rst rename to docs/userland/libc/apis/api-list/string.md index 3062608f..88b137b5 100644 --- a/docs/userland/libc/apis/api-list/string.rst +++ b/docs/userland/libc/apis/api-list/string.md @@ -1,11 +1,11 @@ -string.h -==================================== -简介: - ==== +# string.h + +## 简介: + 字符串操作 -函数列表: - ===== +## 函数列表: + ``size_t strlen(const char *s)`` : 返回字符串长度 ``int strcmp(const char *a,const char *b)`` 比较字符串的字典序 diff --git a/docs/userland/libc/apis/api-list/time.rst b/docs/userland/libc/apis/api-list/time.md similarity index 74% rename from docs/userland/libc/apis/api-list/time.rst rename to docs/userland/libc/apis/api-list/time.md index 3920f3a7..c2f49386 100644 --- a/docs/userland/libc/apis/api-list/time.rst +++ b/docs/userland/libc/apis/api-list/time.md @@ -1,26 +1,26 @@ -time.h -==================================== -简介: - ===== +# time.h + +## 简介: + 时间相关 时刻以纳秒为单位 -结构体: - ==== +## 结构体: + ``struct timespec`` : 时间戳 - 变量列表: - ===== + ### 变量列表: + ``long int tv_sec`` : 秒 ``long int tv_nsec`` : 纳秒 -宏定义: - ==== +## 宏定义: + ``#define CLOCKS_PER_SEC 1000000`` 每一秒有1000000个时刻(纳秒) -函数列表: - ===== +## 函数列表: + ``int nanosleep(const struct timespec *rdtp,struct timespec *rmtp)`` 休眠指定时间 diff --git a/docs/userland/libc/apis/api-list/unistd.rst b/docs/userland/libc/apis/api-list/unistd.md similarity index 94% rename from docs/userland/libc/apis/api-list/unistd.rst rename to docs/userland/libc/apis/api-list/unistd.md index 1fb8f78d..e6cdacde 100644 --- a/docs/userland/libc/apis/api-list/unistd.rst +++ b/docs/userland/libc/apis/api-list/unistd.md @@ -1,11 +1,11 @@ -unistd.h -==================================== -简介: - ===== +# unistd.h + +## 简介: + 也是一些常用函数 -函数列表: - ====== +## 函数列表: + ``int close(int fd)`` : 关闭文件 ``ssize_t read(int fd,void *buf,size_t count)`` : 从文件读取