Skip to content
This repository has been archived by the owner on Feb 27, 2023. It is now read-only.

Commit

Permalink
Merge pull request #1261 from pouchrobot/auto-doc-2020-03-25
Browse files Browse the repository at this point in the history
docs: auto generate Dragonfly cli/api/contributors docs via code
  • Loading branch information
allencloud authored Mar 25, 2020
2 parents df222f9 + abe08cd commit b184f25
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 0 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTORS
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ zhouhaibing089 <[email protected]>
zhoulin xie <[email protected]>
zou sheng <[email protected]>
zousheng <[email protected]>
ZouYu <[email protected]>
zuozheng.hzz <[email protected]>
也行 <[email protected]>
宋文杰 <[email protected]>
Expand Down
6 changes: 6 additions & 0 deletions docs/api_reference/apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -735,6 +735,11 @@ Arch, Version, BuildDate, and GitCommit.
<a name="definitions"></a>
## Definitions

<a name="cdnsource"></a>
### CdnSource
*Type* : enum (supernode, source)


<a name="dfgettask"></a>
### DfGetTask
A download process initiated by dfget or other clients.
Expand Down Expand Up @@ -962,6 +967,7 @@ response get from task creation request.
|Name|Description|Schema|
|---|---|---|
|**ID** <br>*optional*|ID of the created task.|string|
|**cdnSource** <br>*optional*||[CdnSource](#cdnsource)|
|**fileLength** <br>*optional*|The length of the file dfget requests to download in bytes.|integer (int64)|
|**pieceSize** <br>*optional*|The size of pieces which is calculated as per the following strategy<br>1. If file's total size is less than 200MB, then the piece size is 4MB by default.<br>2. Otherwise, it equals to the smaller value between totalSize/100MB + 2 MB and 15MB.|integer (int32)|

Expand Down
1 change: 1 addition & 0 deletions docs/cli_reference/supernode.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ supernode [flags]

```
--advertise-ip string the supernode ip is the ip we advertise to other peers in the p2p-network
--cdn-pattern string cdn pattern, must be in ["local", "source"]. Default: local (default "local")
--config string the path of supernode's configuration file (default "/etc/dragonfly/supernode.yml")
-D, --debug switch daemon log level to DEBUG mode
--down-limit int download limit for supernode to serve download tasks (default 4)
Expand Down

0 comments on commit b184f25

Please sign in to comment.