开发工具 on 奕晨's blog

git基础教学

Sun, 09 Mar 2025 00:00:00 +0000

引言

Git 是一个分布式版本控制系统，用于在软件开发过程中跟踪源代码的变更。它由 Linus Torvalds 于 2005 年创建，最初是为了管理 Linux 内核的开发。本文主要介绍了git中的常见命令，以及日常工作使用git的流程。

参考资料: 【GeekHour】一小时Git教程_哔哩哔哩_bilibili

基本操作

新建仓库

1
2
3

git init		# 在本地创建一个空仓库

git clone 远程地址		# 从远程服务器克隆仓库

新建仓库后生成.git文件，就是仓库

工作区域和文件状态

基本操作

新建文件都是未跟踪的文件，需要执行git add进行跟踪

git add 文件名 # 将文件放入暂存区（包括未跟踪的文件）
git commit -m"解释" # 将文件放入本地仓库

git add -u 文件名 # 将已经跟踪的文件放入暂存区，对于新建的文件不能使用

git commit -am"解释" #相当于两个命令， git add -u , git commit -m"解释"

取消add

`1`	`git restore --stage file2 # add过后将文件取消add,即从暂存区拿回工作区`

git reset回退版本

git reset --soft HEAD^			#本地仓库回退到上个版本，工作区和暂存区保留

git log # 查看当前仓库经历的版本
git log --oneline #一行表示

git reset --mix HEAD 版本号		#本地仓库回退到指定版本，工作区保留，暂存区不保留

git reset --hard HEAD 版本号		# 本地仓库回退到指定版本，工作区和暂存区不保留

注意事项

回退版本会导致版本丢失，使用git reflog指令查看本地仓库的操作历史，存储再.git/log中

git reflog 的注意事项

本地记录：git reflog 只记录本地仓库的操作历史，不会同步到远程仓库。
过期时间：默认情况下，git reflog 记录会保留 90 天。过期后，记录会被自动清理。
不能恢复未提交的更改：git reflog 只能恢复已经提交的记录，无法恢复未提交的更改（如工作目录中的修改）。

git diff查看差异

查看工作区，暂存区，本地仓库之间的差异

git diff # 查看工作区和暂存区文件的差异，
#如果暂存区没有文件，查看工作区和本地仓库之间的差异，相当于git diff HEAD

git diff HEAD # 查看工作区和本地仓库之间的差异

git diff --cached # 查看暂存区和本地仓库之间的差异

比较两个版本之间的差异

git diff 版本号1 版本号2  # 显示版本号2在版本号1基础上做了哪些修改
git diff HEAD~ HEAD		# 显示最新版本在上一个版本基础上做了那些修改
# 上面的命令会显示所有文件发生的变化


# 查看指定文件的差异内容
git diff HEAD~ HEAD 文件名

比较两个分支之间的差异

git rm删除版本库中的文件

# 方法一
rm 文件名 # 先删除本地工作区文件
git add 文件名 # 更新暂存区
git commit -m"删除文件" # 同步到本地仓库

# 方法二
git rm 文件名  # 相当于方法一的1，2两步
git commit -m"删除文件"

# 不删除工作区文件
git rm --cached 文件名   # 其作用是从暂存区删除，并取消跟踪，文件会变为未跟踪
# 后续可以执行git commit 删除本地仓库的文件，或者等下一次提交

.gitignore文件

添加忽略文件，文件名可以使用通配符

系统或者软件自动生成的文件
编译长生的中间文件和结果文件
运行时生成日志文件、缓存文件、临时文件
涉及身份、密码、口令、密钥等敏感信息文件

对于已经在版本库中的文件，./gitignore文件不起作用，需要使用git rm –cached命令取消跟踪文件，并告知暂存区删除文件

远程仓库

配置ssh

进入用户的.ssh目录
使用ssh-keygen -t rsa生成ssh密钥(可以指定文件名和密码，一直回车就都不指定)
将公钥传到远程仓库

这样就可以使用ssh进行clone了

如果指定了生成的文件名，那么就需要生成一个配置文件config，以github为例，文件名内容如下

# github
Host github.com
HostName github.com
PreferredAuthentications publickey
IdentityFile ~/.ssh/指定的生成ssh密钥的文件名

与远程仓库关联

 git remote add origin 远程仓库地址
 # origin是远程仓库的别名，origin代指远程仓库
 
 git branch -M main # 指定分支名称为main
 
 git push -u origin main	# 将本地仓库和远程仓库关联起来
 # 实际是 git push -u origin main:main 把本地仓库和远程仓库origin关联，把本地仓库main分支推送给远程仓库main分支
 # 本地分支名称和远程分支名称相同，就可以吧main:main省略为一个main
 
 git remote -v # 显示关联远程仓库的信息

拉取远程仓库

1
2

git pull 远程仓库别名 远程仓库分支名:本地仓库分支名			# 从远程仓库拉去分支，分支名相同只要写一个即可
# git pull 会自动执行一次合并操作，如果没有冲突，合并操作就会完成

关于冲突和git fetch，在分支冲突进行讲解

分支

分支操作

git branch # 查看分支

git branch 分支名 # 创建新分支
git switch 分支名 # 切换分支

# 上面两行命令可以用一个命令来表示
git swtich -c 分支名

#注意别忘了切换分支
git merge 将要合并的分支名 # 把将要合并的分支合并到当前分支当中

git log --graph --oneline # 查看分支图

# 如果分支合并后，该分支还存在，如果分支不再被需要，需要手动删除
git branch -d 分支名 # 删除已经合并的分支
git branch -D 分支名 # 强制删除分支，不管有没有合并

解决冲突

# git merge发生冲突如何解决
# git merge发生冲突后，文件名里的内容会把冲突前后的差别都展示出来
git status # 查看信息
git diff # 查看冲突的内容
vim 文件名 # 手动编辑文件
git commit -am"提交更改后的文件" # 提交并自动合并

git merge --abort # 终止合并

rebase操作

执行rebase会把分支变为一条直线

找两分支的公共祖先

1
2
3

git log --oneline --graph --decoreate --all	# 查看详细分支信息

git rebase 分支1  # 把当前分支与分支1公共节点开始往后的当前分支全部放到分支1后面

会改变提交历史，要避免在共享分支上使用rebase

git模型

gitFlow模型

Master和Develop为主分支，长期存在；其他分支为辅助分支，合并完要删除，具体流程如下图所示

githubFlow模型

自己创建分支修改后发出合并请求

CMake创建c++项目简明教程

Fri, 10 Jan 2025 00:00:00 +0000

引言

CMake 是一个跨平台的构建系统生成器，用于自动化构建、测试和打包软件项目的过程。CMake 通过一系列源代码文件和配置设置，生成平台特定的构建文件（例如 Makefile、Visual Studio 项目文件等）。

CMake语法

依次使用以下命令生成项目(对于CmakeLists.txt)

1
2

cmake -B build  # 创建build文件夹和相关文件
cmake --build build  # 生成项目

语法简介

cmake -P *.cmake命令来运行cmake文件

# 单行打印
message("hello")
message(hello)

# 多行打印
message("first line
second line")
message([[first line
second line]])

# 打印cmake版本号，使用CMAKE_VERSION变量 ${}
message(${CMAKE_VERSION})

set设置变量


set(Var1 "hello")
set(Var2 world)

# 打印单行hello world
message(${Var1}
${Var2})

# 打印多行hello world
message("${Var1}
${Var2}") 

message("------------------------")

set(VarLists a1 a2)
message(${VarLists})    #a1a2

# 打印环境变量
message($ENV{PATH})

# 创建cmake项目的环境变量
set(ENV{CXX} "g++")
message($ENV{CXX})

# 删除刚刚创建的环境变量
unset(ENV{CXX})

list

list(操作方式操作对象可能有操作返回结果的变量)

list(APPEND port p1 p2 p3)
message(${port})    # p1p2p3

list(LENGTH port len)
message(${len})     # 3 (变量长度为3)

list(FIND port p2 index)
message(${index})   # 1 (p2在1的位置)

list(REMOVE_ITEM port p1)
message(${port})    # p2p3 (删除p1)

list(INSERT port 1 p2.5)
message(${port})    # p2p2.5p3 (在1位置插入p2.5)

list(REVERSE port)
message(${port})    # p3p2.5p2 (进行反转)

list(SORT port)
message(${port})    # p2p2.5p3 (进行排序)

流程控制

if流程

set(VAR1 TRUE)
set(VAR2 FALSE)

if(VAR1)    # 简单判断
    message(TRUE)
else()
    message(FALSE)
endif()

if(NOT VAR1) # NOT不能是not，大小写敏感
    message(TRUE)
else()
    message(FALSE)
endif()

if(VAR1 AND VAR2)   # OR用法也是如此
    message(TRUE)
else()
    message(FALSE)
endif()

if(1 LESS 2)        # 比较,其实还是字符串的比较
    message("1 less 2")
else()
    message("error")
endif()

if(2 GREATER 1)
    message("2 greater 1")
endif()

if(2 EQUAL "2")
    message("2 equal \"2\"")
endif()

for流程

foreach(VAR RANGE 3)
    message(${VAR}) # 0 1 2 3 (跟一般编程语言区别很大)
endforeach()

set(MY_LISTS 1 2 3)
foreach(VAR IN LISTS MY_LISTS ITEMS 4 f)
    message(${VAR}) # 1 2 3 4 f
endforeach()

message("----------------------")

set(L1 one two three)
set(L2 1 2 3 4)
foreach(num IN ZIP_LISTS L1 L2)
    message("word = ${num_0}, num = ${num_1}")
endforeach()
# word = one, num = 1
# word = two, num = 2
# word = three, num = 3
# word = , num = 4

函数

function(MyFunc FirstArg) # 函数名MyFunc
    message("MyFunc Name: ${CMAKE_CURRENT_FUNCTION}")
    message("FIRST ${FirstArg}")    # 使用形参列表使用参数
    set(FirstArg "New value")
    message("FirstArg again: ${FirstArg}")
    message("ARGV0 ${ARGV0}")       # 不使用形参列表使用参数
    message("ARGV1 ${ARGV1}")
    message("ARGV2 ${ARGV2}")
endfunction()

set(FirstArg "first value")         
MyFunc(${FirstArg} "value")         # 可以传入和新参列表不一样数目的实参
message("FirstArg ${FirstArg}")     # 函数内部修改不会改变函数外面

# MyFunc Name: MyFunc
# FIRST first value
# FirstArg again: New value
# ARGV0 first value
# ARGV1 value
# ARGV2
# FirstArg first value

宏

macro(Test myVar)
    set(myVar "new value")  # 新建的变量，不是上面的参数
    message("argument: ${myVar}")   #${myVar}会变为传入的myVar
endmacro()

set(myVar "First value")
message("myVar: ${myVar}")
Test("value")   # 将宏代码复制到了这里
message("myVar: ${myVar}")

# myVar: First value
# argument: value
# myVar: new value

简单的CMake项目

在这个简单的CMake项目中，有如下的项目结构
整个项目只有一个CMakeLists.txt，所有的源文件和头文件都放在项目目录中，bin中存放的是最终的可执行程序。

CMakeLists.txt中的代码如下

cmake_minimum_required(VERSION 3.29.0)  # 确定CMake版本
project(planning)                       # 项目名
set(CMAKE_CXX_STANDARD 17)              # 使用的语言和版本

set(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)    # 设定可执行文件的路径
aux_source_directory(. SRC_LISTS)                        # 添加当前目录所有源文件路径到SRC_LIST变量中
add_executable(planning_main ${SRC_LISTS})      # 通过源文件创建目标可执行文件

分文件编写的的CMake项目

在这个份文件的CMake项目中，有如下的项目结构
整个项目只有一个CMakeLists.txt，src文件夹里面存放的是源文件，include文件夹中存放的是头文件，bin中存放的是最终的可执行程序。

CMakeLists.txt中的代码如下

cmake_minimum_required(VERSION 3.20.0) # 确定CMake版本
project(my_hello)                      # 项目名
set(CMAKE_CXX_STANDARD 17)             # 使用的语言和版本

include_directories(${PROJECT_SOURCE_DIR}/include)  # 指定头文件搜索路径
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)   # 设定可执行文件的路径

aux_source_directory(${PROJECT_SOURCE_DIR}/src SRC_LIST)    # 添加src目录下所有源文件路径到SRC_LIST变量中

add_executable( # 通过源文件创建目标可执行文件
    my_hello
    ${SRC_LIST}
)

共享库

在创建共享库的项目中，有如下目录结构
注意到bin中多出了libcommon.dll动态链接库文件。同时，main程序在项目目录下，其他.cpp文件存放在了src目录中，头文件存放在了include目录中。

CMakeLists.txt中的代码如下

cmake_minimum_required(VERSION 3.29.0)
project(planning)
set(CMAKE_CXX_STANDARD 17)

# 设置生成的动态库存放路径
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_SOURCE_DIR}/bin)
#linux下使用 CMAKE_LIBRARY_OUTPUT_DIRECTORY 变量
#静态库使用 CMAKE_ARCHIVE_OUTPUT_DIRECTORY 变量

aux_source_directory(${PROJECT_SOURCE_DIR}/src SRC_LISTS)

# 创建了名为common的动态库
add_library(common 
SHARED
${SRC_LISTS}
)
# add_library(common STATIC ${SRC_LISTS}) 创建的是静态库

# 为动态库添加头文件目录
target_include_directories(common
PUBLIC
${PROJECT_SOURCE_DIR}/include
)

#生成可执行程序
add_executable(planning_main planning_main.cpp)

# 为目标 planning_main 设置头文件目录
target_include_directories(planning_main
    PUBLIC
    ${PROJECT_SOURCE_DIR}/include
)

# 为目标 planning_main 链接 common 库
target_link_libraries(planning_main
    PUBLIC
    common
)

CmakeLists嵌套

项目有如下目录结构
项目文件夹下有一个CmakeLists文件；src文件夹里有一个CmakeLists文件，主程序和几个类的文件夹；同时src中每个类各自的文件夹都包含了CmakeLists，.cpp，.h三个文件

嵌套使用的时候上层CmakeLists文件的变量会传入到下层的CmakeLists文件当中。

项目文件夹下的CmakeLists.txt代码如下

cmake_minimum_required(VERSION 3.29.0)
project(planning
    VERSION 0.0.1
    DESCRIPTION "a demo of cmake planning"
    LANGUAGES CXX
)

set(CMAKE_CXX_STANDARD 17)

# 一些后面要使用的变量
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_SOURCE_DIR}/bin)
set(PROCESS_DIR ${CMAKE_SOURCE_DIR}/src/process)
set(PNC_MAP_DIR ${CMAKE_SOURCE_DIR}/src/pnc_map)

# 增加子目录
add_subdirectory(src)

src文件夹下的CmakeLists.txt代码如下

project(planning_main)

# 添加子目录
add_subdirectory(pnc_map)
add_subdirectory(process)

# 根据planning_main.cpp形成可执行文件
add_executable(${PROJECT_NAME} planning_main.cpp)

# 生成可执行文件需要process.h
target_include_directories(${PROJECT_NAME}
PUBLIC
${PROCESS_DIR}
)

# 链接库需要process库
target_link_libraries(${PROJECT_NAME}
    PUBLIC
    process
)

两个类中的CmakeLists代码分别如下

project(process)

add_library( ${PROJECT_NAME}
SHARED
process.cpp
)

# 生成库需要pnc_map.h	注意，这是根据代码的关系决定，本例代码中，类process有pnc_maplei'x的成员变量
target_include_directories(${PROJECT_NAME} 
PUBLIC
${PNC_MAP_DIR}
)

# 生成库需要pnc_map库
target_link_libraries(${PROJECT_NAME}
PUBLIC
pnc_map
)

project(pnc_map)

add_library( ${PROJECT_NAME}
SHARED
pnc_map.cpp
)