MSSCCPRJ. Fichier de contrôle de code sourceMSSCCPRJ.SCC File

Lorsqu’une solution Visual Studio ou un projet est placé sous contrôle de code source à l’aide de l’IDE, l’IDE reçoit deux éléments d’information clés à partir du contrôle de source de plug-in sous la forme de chaînes.When a Visual Studio solution or project is placed under source control using the IDE, the IDE receives two key pieces of information from the source control plug-in in the form of strings. Ces chaînes, « AuxPath » et « NomProj », sont opaques à l’IDE, mais ils sont utilisés par le plug-in pour rechercher la solution ou le projet de contrôle de version.These strings, "AuxPath" and "ProjName", are opaque to the IDE, but they are used by the plug-in to locate the solution or project in version control. L’IDE obtienne généralement ces chaînes de la première fois en appelant le SccGetProjPath, et il puis les enregistre dans le fichier solution ou un projet pour les appels ultérieurs à la SccOpenProject.The IDE typically obtains these strings the first time by calling the SccGetProjPath, and it then saves them in the solution or project file for future calls to the SccOpenProject. Lorsqu’il est incorporé dans les fichiers solution et projet, les chaînes « AuxPath » et « NomProj » pas sont mises à jour automatiquement lorsqu’un utilisateur crée une branche, de branches, ou copie les fichiers solution et projet qui se trouvent dans le contrôle de version.When embedded in the solution and project files, the "AuxPath" and "ProjName" strings are not automatically updated when a user branches, forks, or copies solution and project files that are in version control. Pour vous assurer que les fichiers solution et projet pointent vers leur emplacement approprié dans le contrôle de version, les utilisateurs doivent mettre à jour manuellement les chaînes.To make sure that the solution and project files point to their correct location in version control, users must manually update the strings. Étant donné que les chaînes sont destinés à être opaque, il ne peut pas toujours être clair comment ils doivent être mis à jour.Because the strings are meant to be opaque, it may not always be clear how they should be updated.

Le plug-in de contrôle de code source peut éviter ce problème en stockant les chaînes « AuxPath » et « NomProj » dans un fichier spécial appelé le MSSCCPRJ. Fichier de contrôle de code source.The source control plug-in can avoid this problem by storing the "AuxPath" and "ProjName" strings in a special file called the MSSCCPRJ.SCC file. Il s’agit d’un fichier local, côté client qui est détenu et géré par le plug-in.It is a local, client-side file that is owned and maintained by the plug-in. Ce fichier n’est jamais placé sous contrôle de code source, mais est généré par le plug-in pour chaque répertoire qui contient les fichiers de contrôle de code source.This file is never placed under source control but is generated by the plug-in for every directory that contains source-controlled files. Pour déterminer quels fichiers sont des fichiers solution et projet de Visual Studio, un plug-in de contrôle de code source peut comparer les extensions de fichier par rapport à une liste standard ou fourni par l’utilisateur.To determine which files are Visual Studio solution and project files, a source control plug-in can compare the file extensions against a standard or user-supplied list. Une fois que l’IDE détecte qu’un plug-in prend en charge la MSSCCPRJ. Fichier de contrôle de code source, il cesse d’incorporer la « AuxPath » et les chaînes « NomProj » dans la solution, les fichiers de projet et il lit la MSSCCPRJ ces chaînes. Le fichier de contrôle de code source à la place.Once the IDE detects that a plug-in supports the MSSCCPRJ.SCC file, it ceases to embed the "AuxPath" and "ProjName" strings into solution and project files, and it reads those strings from the MSSCCPRJ.SCC file instead.

Un contrôle de code source du plug-in qui prend en charge la MSSCCPRJ. Fichier de contrôle de code source doit respecter les consignes suivantes :A source control plug-in that supports the MSSCCPRJ.SCC file must adhere to the following guidelines:

  • Il ne peut exister qu’un seul MSSCCPRJ. Fichier de contrôle de code source par répertoire.There can only be one MSSCCPRJ.SCC file per directory.

  • Un MSSCCPRJ. Fichier de contrôle de code source peut contenir le « AuxPath » et « NomProj » pour plusieurs fichiers qui sont sous contrôle de code source dans un répertoire donné.An MSSCCPRJ.SCC file can contain the "AuxPath" and "ProjName" for multiple files that are under source control within a given directory.

  • La chaîne « AuxPath » ne doit pas avoir de guillemets qu’il contient.The "AuxPath" string must not have quotes inside it. Il est autorisé à placer entre guillemets comme délimiteurs (par exemple, une paire de guillemets doubles peut être utilisée pour indiquer une chaîne vide).It is allowed to have quotes around it as delimiters (for example, a pair of double quotes can be used to indicate an empty string). L’IDE supprimera tous les devis à partir de la chaîne « AuxPath » lorsqu’il est lu à partir de la MSSCCPRJ. Fichier de contrôle de code source.The IDE will strip all quotes from the "AuxPath" string when it is read from the MSSCCPRJ.SCC file.

  • La chaîne « NomProj » dans le MSSCCPRJ. Fichier de contrôle de code source doit correspondre exactement à la chaîne retournée par la SccGetProjPath (fonction).The "ProjName" string in the MSSCCPRJ.SCC file must match exactly the string returned from the SccGetProjPath function. Si la chaîne retournée par la fonction est entre guillemets, la chaîne dans le MSSCCPRJ. Fichier de contrôle de code source doive être placées entre guillemets autour d’elle et vice versa.If the string returned by the function has quotes around it, the string in the MSSCCPRJ.SCC file must have quotes around it, and vice versa.

  • Un MSSCCPRJ. Fichier de contrôle de code source est créé ou mis à jour chaque fois qu’un fichier est placé sous contrôle de code source.An MSSCCPRJ.SCC file is created or updated whenever a file is placed under source control.

  • If un MSSCCPRJ. Fichier de contrôle de code source est supprimé, un fournisseur doit régénérer la prochaine fois qu’il effectue une opération de contrôle de code source concernant ce répertoire.If an MSSCCPRJ.SCC file gets deleted, a provider should regenerate it the next time it performs a source control operation concerning that directory.

  • Un MSSCCPRJ. Contrôle de code source doit suivre strictement le format défini.An MSSCCPRJ.SCC file must strictly follow the defined format.

Obtenir une Illustration de la MSSCCPRJ. Format de fichier de contrôle de code sourceAn Illustration of the MSSCCPRJ.SCC File Format

Voici un exemple de la MSSCCPRJ. Format de fichier de contrôle de code source (les numéros de ligne sont uniquement des indications et ne doivent pas être inclus dans le corps du fichier) :Following is a sample of the MSSCCPRJ.SCC file format (the line numbers are only provided as a guide, and should not be included in the file body):

[Ligne 1] SCC = This is a Source Code Control file[Line 1] SCC = This is a Source Code Control file

[Ligne 2][Line 2]

[Ligne 3] [TestApp.sln][Line 3] [TestApp.sln]

[Ligne 4] SCC_Aux_Path = "\\server\vss\"[Line 4] SCC_Aux_Path = "\\server\vss\"

[Ligne 5] SCC_Project_Name = "$/TestApp"[Line 5] SCC_Project_Name = "$/TestApp"

[Ligne 6][Line 6]

[Ligne 7] [TestApp.csproj][Line 7] [TestApp.csproj]

[Ligne 8] SCC_Aux_Path = "\\server\vss\"[Line 8] SCC_Aux_Path = "\\server\vss\"

[Ligne 9] SCC_Project_Name = "$/TestApp"[Line 9] SCC_Project_Name = "$/TestApp"

La première ligne indique la fin du fichier et sert à la signature pour tous les fichiers de ce type.The first line states the purpose of the file and serves as the signature for all files of this type. Cette ligne doit apparaître exactement comme dans tous les MSSCCPRJ. Fichiers SCC :This line should appear exactly like this in all MSSCCPRJ.SCC files:

SCC = This is a Source Code Control file

Ce qui suit est une section de paramètres pour chaque fichier, marquée par le nom de fichier entre crochets.What follows is a section of settings for each file, marked by the file name in square brackets. Cette section est répétée pour chaque fichier en cours de suivi.This section is repeated for each file being tracked. Cette ligne est un exemple d’un nom de fichier, à savoir, [TestApp.csproj].This line is a sample of a file name, namely, [TestApp.csproj]. L’IDE attend que les deux lignes suivantes.The IDE expects the following two lines. Il ne définit pas, toutefois, du style des valeurs définies.It does not, however, define the style of the values defined. Les variables sont SCC_Aux_Path et SCC_Project_Name.The variables are SCC_Aux_Path and SCC_Project_Name.

SCC_Aux_Path = "\\server\vss\"

SCC_Project_Name = "$/TestApp"

Il n’existe pas de délimiteur de fin de cette section.There is no end delimiter to this section. Le nom de fichier, ainsi que tous les littéraux qui apparaissent dans le fichier, sont définies dans le fichier d’en-tête scc.h.The name of the file, as well as all literals that appear in the file, are defined in the scc.h header file. Pour plus d’informations, consultez chaînes utilisées en tant que clés pour la recherche d’un plug-in de contrôle de code Source.For more information, see Strings Used as Keys for Finding a Source Control Plug-in.

Voir aussiSee Also

Plug-ins de contrôle de code source Source Control Plug-ins
Chaînes utilisées comme clés pour rechercher un plug-in de contrôle de code sourceStrings Used as Keys for Finding a Source Control Plug-in