repo manifest文件格式说明

翻译自repo doc

repo的manifest文件描述了repo client的结构:哪些目录能够被下载,并且可以从哪里xia下载

基本的manifest的git裸仓库只包含了一个default.xml.

manifest仓库也是通过git进行版本控制,当我们执行repo sync的时候会自动更新manifest仓库。

manifest的xml有以下结构构成:

  • <manifest>根标签

  • <remote>标签

    在xml中可以有多个<remote>标签,每个<remote>标签代表了一个Git仓库的地址,一个或多个<project>可以使用该地址来下载代码,并且<remote>标签还可以通过review属性来指定Gerrit review server的地址

    看一下<remote>标签都可以有哪些属性
    name:代表 该Git Url的名字,在xml中必须唯一。所有使用该Git Url下载代码的<project>所对应的.git/config中都会默认使用该name作为远端仓库的名称,所以我们在该project下执行git fetch,git remote,git pull等操作都会自动的从该Git Url同步代码。

    alias:对name的别名,alias允许重复。如果我们指定了alias,那么alias会覆盖对应Project下的.git/config中的远端仓库的名称。这样就允许不同的Git Url有相同的名称,方便做统一管理。

    fetch:完整下载Url的前缀,比如git@chico.dong.git,当下载某一个Project的时候,他会和<project>标签中的name属性拼成完整的url,比如git@chico.dong.git/mysample

    pushurl:这个是可选属性,当指定该属性的时候,这个值会和<project>标签中的name属性拼成完整的push url路径,这样当我们使用git push命令的时候,就会使用该url。如果不指定该属性,则pushurlfetch一样。

    review:这个属性是可选的,用来指定Gerrit review server的完整ulr。当指定这个属性的时候,我们使用repo upload命令上传的代码就会上传到该服务器上。如果不指定该属性的话,repo upload命令将不能使用

    revision:可选属性,用来指定每个Project默认使用的git branch。每个<project>可以有自己的revision属性,会覆盖默认的。

  • <default>标签

最多可以指定一个<default>标签。该标签用来提供一些默认值。看一下它的属性

remote:标签来用来引用某个<remote>标签的name属性值。当<project>不指定remote属性的时候采用该值
revieson:当一个<project>不指定revision的时候使用该值
dest-branch:用来指定Project使用的git branch。<project>不指定dest-branch的时候使用该值。如果不指定该值,默认会使用revision指定的branch.
upstream:该属性代表了一个git提交节点的sha1值。当使用-c模式去指定同步某一个revision的代码时,通过指定upstrem可以使其只同步到该sha1,避免同步整个git节点。如果<project>没有指定该属性,就会使用这个默认值。
sync-c:当设置该值为true的时候,同步project的时候就只会同步<revision>指定的branch,而不是所有的branch.
sync-s:当设置该值为true的时候,会同步该Project的sub-project
sync-tags:设置该值为false,也是只会同步<revision>指定的分支,否则会同步所有tag。
clone-depth:该属性代表了在同步Project的时候,需要同步最新的多少个commit,默认是都同步。如果<project>没有指定该属性,则会使用该默认值。
``

  • <project>标签,每一个<project>代表了一个可以被clone到工作区的仓库。<project>允许嵌套,也就是说允许<project>在嵌套<project>,里面的那个<project>被成为Sub-modules.里面<project>的属性自动继承外面<project>的属性

name:最重要的一个属性,<project>的name属性会被用来和<remote>标签的<fetch>属性拼成该project最终的url。像下面这样
${remote_fetch}/${project_name}.git
.git是repo自动帮我们添加的。如果这个project有一个parent属性,则该project最终的url会被这样拼凑
${remote_fetch}/${project_parent}/${project_name}.git

path:从该git下载下来的代码在本地的保存路径,相对于repo的根目录而言。如果不指定path属性,则会使用name属性。

remote含义和上面一样。

revision:和上面的含义一样,是manifest想要track的git branch的名称。这个属性理论上只能是git branch的名称,但是实际上可以是sha1或者是tag。

dest-branch:git branch的名称,当我们使用repo upload命令的时候,代码会上传到这个branch.如果不指定的话,就会使用revision.

groups:该project所属的group,一个project可以属于多个group,多个group用 空格或者逗号 分开。所有的project都属于group "all",每个project还额外属于两个group,一个是"name":name"path":path,比如<project name="monkeys" path="barrel-of"/>,它自动属于default,name:monkeys,path:barrel-off这三个组。如果我们声明一个Project属于notdefault这个组,repo将不会自动下载这个project.如果这个project有parent属性,那么name组和path组将会把parent属性值作为前缀。

sync-c:和上面一样,只下载revision指定的branch

sync-s:自动下载sub-modules,就是嵌套的<project>。默认是不会自动下载sub-modules的

upstream:和上面的含义一样。当sync-c的时候,只同步到该节点指定的代码,不用同步整个ref。
clone-depth:和上面的含义一样,用来指定同步最新的几个commit
force-path这个属性基本用不到,当不设置这个属性的时候,我们创建本地镜像的时候,都会按照name属性来组织,但是当设置这个属性为true的时候,会按照path属性来组织。这个属性只有在同步的时候有--mirror参数的时候才会生效。

  • <extend-project>标签,这个标签没见有人用过,具体也不知道有什么效果……
    这个属性最常用在本地的manifest当中,可以对已经存在的project的属性进行修改,而不用更改整个project的定义。它有几个属性:

    path:如果被指定的话,强制project被checkout 到指定的目录。
    revision,groups和上面的含义一样

  • <annotation>标签

一个<project>标签可以有零个或者多个<annotation>标签,每个<annotation>标签声明了一个键值对,这个键值对可以在对该project执行forall命令的时候作为环境变量被使用。
它有一个 keep属性 ,有true或者false两个值,表明这个<annotation>在执行subcommand的时候是否会被保留。

  • <copyfile>标签

可以作为<project>标签的子标签,每一个<copyfile>标签表明了在repo sync的时候从src把文件拷贝到destsrc相对于该project来说,dest相对于根目录来说。

  • <linkfile>标签

和<copyfile>标签的作用类似,不过是不进行拷贝,而是进行一个符号链接

  • <remove-project>这个属性不知道怎么用,但是从翻译来看,这个属性经常用在内部的manifest中,这样就允许同一个manifest中后来的<project>用不同的source来替换这个project.不明觉厉,完全不懂
    这个属性最长用在local manifest中就可以了,平时遇不到。

  • <include>
    用来引入一个其他的manifest,有一个name属性指向被引用的manifest, 路径是相对于mamanifest库的根目录

Local Manifest

Local Manifest可以提供额外的<remote>和<project>.local manifest的存储路径是$TOP_DIR/.repo/local_manifests/*.xml

注意local_manifests文件夹中定义的所有.xml文件,在repo sync的时候都会被优先的下载。也就是说这个文件夹下的所有xml文件所定义的<project>都会被下载。
每个local manifest按照字母顺序被加载,也就是a.xml中的Project先下载,然后下载b.xml中的project.

.repo下有一个local_manifest.xml文件,也就是.repo/local_manifest.xml,这个文件是最先被加载的,然后才是local_manifests文件夹下的xml文件.repo/local_manifests/*.xml.

以上就把repo的manifest结构全部讲完了

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,290评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,399评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,021评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,034评论 0 207
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,412评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,651评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,902评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,605评论 0 199
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,339评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,586评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,076评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,400评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,060评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,083评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,851评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,685评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,595评论 2 270

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,100评论 18 139
  • Repo 是一款工具,可让您在 Android 环境中更轻松地使用 Git。 安装GIT 省略 安装Repo 要安...
    周润发_223a阅读 70,644评论 0 17
  • https://source.android.com/setup/develop/repo 1 repo介绍 An...
    haorong123阅读 64,448评论 1 11
  • 服务端 本地搭建repo服务器的方法: 首先得确保本地的git能够正常使用,并下载一个repo可以正常运行 目录结...
    天空汁橙阅读 3,920评论 1 2
  • 建善寺位于福建省霞浦县松港街道东郊,距城关1公里,始建于南齐永明元年(483),是福建省现存年代最久的佛寺之一,素...
    文贝阅读 1,044评论 4 14