Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history 
Update the documentation related to the sources field

Log: update docs
  • Loading branch information
@chenchongbiao
chenchongbiao committed Jan 13, 2025
1 parent ba889e2 commit 9fce677
Show file tree
Hide file tree
Showing 2 changed files with 114 additions and 20 deletions.
73 changes: 60 additions & 13 deletions docs/pages/en/guide/ll-builder/manifests.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ package:
The minimum root filesystem.
| name | description |
| ------- | --------------------------------------------------------------------------------------- |
| id | Unique name of the base |
| name | description |
| ------- | ---------------------------------------------------------------------------------------- |
| id | Unique name of the base |
| version | Base version, A three-digit number can be loosely matched with a potential fourth digit |
### Runtime
Expand All @@ -60,14 +60,16 @@ Describes the build and run dependencies of the application.
runtime: org.deepin.runtime.dtk/23.1.0
```
| name | description |
| ------- | ------------------------------------------------------------------------------------------ |
| id | Unique name of the runtime |
| name | description |
| ------- | ------------------------------------------------------------------------------------------- |
| id | Unique name of the runtime |
| version | Runtime version, A three-digit number can be loosely matched with a potential fourth digit |
### Source
Describes the source information.
Describes the source information and retrieve it in the 'linglong/sources' directory of the same level path as linglong.yaml.
#### The kind is Git
```yaml
sources:
Expand All @@ -77,12 +79,57 @@ sources:
commit: d7e207b4a71bbd97f7d818de5044228c1a6e2c92
```
| name | description |
| ------ | --------------------------------------------------------------------------------------------------------- |
| kind | Source code type, optional types git, file, archive, git |
| url | Source address, fill in when the type is archive or git |
| digest | The Hash value of archive file encrypted using sha256 algorithm, fill in when the type is archive or file |
| commit | The hash value of a source code commit, fill in when the type is git |
| name | description |
| ------- | -------------------------------------------------------------------- |
| kind | git, Download using the Git tool |
| url | Source address, fill in when the type is archive or git |
| version | Source repository branches |
| commit | The hash value of a source code commit, fill in when the type is git |
#### The kind is file
```yaml
sources:
kind: file
url: https://github.com/linuxdeepin/deepin-calculator/archive/refs/tags/6.5.4.tar.gz
digest: 9675e27395891da9d9ee0a6094841410e344027fd81265ab75f83704174bb3a8
```
| name | description |
| ------ | ------------------------------------------------------------------ |
| kind | git, Download file |
| url | File download address |
| digest | The hash value of the file is encrypted using the sha256 algorithm |
#### The kind is archive
```bash
sources:
kind: file
url: https://github.com/linuxdeepin/deepin-calculator/archive/refs/tags/6.5.4.tar.gz
digest: 9675e27395891da9d9ee0a6094841410e344027fd81265ab75f83704174bb3a8
```
| name | description |
| ------ | --------------------------------------------------------------------------------- |
| kind | archive, Download the compressed file tar.tz and it will automatically decompress |
| url | File download address |
| digest | The hash value of the file is encrypted using the sha256 algorithm |
#### The kind is dsc
```bash
sources:
kind: dsc
url: https://cdn-community-packages.deepin.com/deepin/beige/pool/main/d/deepin-calculator/deepin-calculator_6.0.1.dsc
digest: ce47ed04a427a887a52e3cc098534bba53188ee0f38f59713f4f176374ea2141
```
| name | description |
| ------ | ------------------------------------------------------------------ |
| kind | dsc, Source code package description file |
| url | File download address |
| digest | The hash value of the file is encrypted using the sha256 algorithm |
### Build rules
Expand Down
61 changes: 54 additions & 7 deletions docs/pages/guide/ll-builder/manifests.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,9 @@ runtime: org.deepin.runtime.dtk/23.1.0
### 源码
描述源码信息。
描述源信息，获取后的位置在 linglong.yaml 同级路径的 `linglong/sources` 目录下。

#### git 类型

```yaml
sources:
Expand All @@ -81,12 +83,57 @@ sources:
commit: d7e207b4a71bbd97f7d818de5044228c1a6e2c92
```

| 名称 | 描述 |
| ------ | --------------------------------------------------------------------- |
| kind | 源码类型，可选类型 file、archive、git |
| url | 源码地址，类型为 file、archive、git 时填写 |
| digest | 归档文件的 hash 值，使用 sha256 算法加密，类型为 file、archive 时填写 |
| commit | 源码某次提交 hash 值，类型为 git 时填写 |
| 名称 | 描述 |
| ------- | ------------------------ |
| kind | git，使用 git 工具下载。 |
| url | 源码地址 |
| version | 源码仓库的分支 |
| commit | 源码某次提交的 hash 值 |

#### file 类型

```bash
sources:
kind: file
url: https://github.com/linuxdeepin/deepin-calculator/archive/refs/tags/6.5.4.tar.gz
digest: 9675e27395891da9d9ee0a6094841410e344027fd81265ab75f83704174bb3a8
```

| 名称 | 描述 |
| ------ | ------------------------------------ |
| kind | file，下载文件 |
| url | 文件下载地址 |
| digest | 文件的 hash 值，使用 sha256 算法加密 |

#### archive 类型

```bash
sources:
kind: file
url: https://github.com/linuxdeepin/deepin-calculator/archive/refs/tags/6.5.4.tar.gz
digest: 9675e27395891da9d9ee0a6094841410e344027fd81265ab75f83704174bb3a8
```

| 名称 | 描述 |
| ------ | ------------------------------------------------ |
| kind | archive，下载文件为 tar.tz 的压缩包，会自动解压 |
| url | 文件下载地址 |
| digest | 文件的 hash 值，使用 sha256 算法加密 |

#### dsc 类型

```bash
sources:
kind: dsc
url: https://cdn-community-packages.deepin.com/deepin/beige/pool/main/d/deepin-calculator/deepin-calculator_6.0.1.dsc
digest: ce47ed04a427a887a52e3cc098534bba53188ee0f38f59713f4f176374ea2141
```

| 名称 | 描述 |
| ------ | ------------------------------------ |
| kind | dsc，源码包描述文件 |
| url | 文件下载地址 |
| digest | 文件的 hash 值，使用 sha256 算法加密 |

### 导出裁剪规则（UAB）

Expand Down

0 comments on commit 9fce677

Please sign in to comment.