Browse Source

fix warnings(markdown rebuild)

wang904 2 years ago
parent
commit
a1d3af9201

+ 1 - 1
docs/introduction/intro.md

@@ -1,3 +1,3 @@
 # DragonOS简介
 
-DragonOS龙操作系统(以下简称“DragonOS”)是一个基于x86-64体系结构开发的,基于GPLv2协议开放源代码的64位操作系统。
+DragonOS龙操作系统(以下简称“DragonOS”)是一个基于x86-64体系结构开发的,基于GPLv2协议开放源代码的64位操作系统。

+ 3 - 0
docs/userland/libc/apis/api-list/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "restructuredtext.preview.name": "docutils"
+}

+ 4 - 7
docs/userland/libc/apis/api-list/ctype.rst → 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`` 
     

+ 5 - 10
docs/userland/libc/apis/api-list/dirent.rst → 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结构体返回
 
-宏定义:
-    ===========================
+## 宏定义:
 
     文件夹类型:
 

+ 9 - 8
docs/userland/libc/apis/api-list/errno.rst → 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*/ 

+ 8 - 8
docs/userland/libc/apis/api-list/fcntl.rst → 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

+ 6 - 5
docs/userland/libc/apis/api-list/math.rst → 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 的绝对值

+ 2 - 2
docs/userland/libc/apis/api-list/printf.rst → docs/userland/libc/apis/api-list/printf.md

@@ -1,3 +1,3 @@
-printf.h
-====================================
+# printf.h
+
 不建议引用,需要 ``printf`` 函数请引用 ``stdio.h`` 

+ 11 - 0
docs/userland/libc/apis/api-list/stddef.md

@@ -0,0 +1,11 @@
+# stddef.h
+
+## 简介: 
+
+    定义了关于指针的常用类型
+
+## 定义:
+
+    ``typedef __PTDIFF_TYPE__ ptrdiff_t``  : 两个指针相减的结果类型
+
+    ``NULL ((void *) 0)`` : 空指针

+ 0 - 11
docs/userland/libc/apis/api-list/stddef.rst

@@ -1,11 +0,0 @@
-stddef.h
-====================================
-简介: 
-    ======
-    定义了关于指针的常用类型
-
-定义:
-    =====
-    ``typedef __PTDIFF_TYPE__ ptrdiff_t``  : 两个指针相减的结果类型
-
-    ``NULL ((void *) 0)`` : 空指针

+ 12 - 12
docs/userland/libc/apis/api-list/stdio.rst → 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 */``

+ 6 - 6
docs/userland/libc/apis/api-list/stdlib.rst → 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)`` : 释放内存

+ 6 - 6
docs/userland/libc/apis/api-list/string.rst → 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)`` 比较字符串的字典序

+ 12 - 12
docs/userland/libc/apis/api-list/time.rst → 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)``
 
         休眠指定时间

+ 6 - 6
docs/userland/libc/apis/api-list/unistd.rst → 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)`` : 从文件读取