Add comments

gatsbyjs · Jul 21, 2020 · c4e1423 · c4e1423
1 parent e1b1590
commit c4e1423
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/packages/gatsby-telemetry/src/repository-id.ts b/packages/gatsby-telemetry/src/repository-id.ts
@@ -92,11 +92,14 @@ function getRepositoryFromHerokuEnv(): IRepositoryId | null {
     return null
   }
 
+  // Parse repository metadata from /proc/*/environ. This is a naive glob approach to only
+  // look pids in procfs.
   const proc = readdirSync(`/proc`).filter(dir => Number.isFinite(Number(dir)))
   const len = proc.length
   for (let i = 0; i < len; i++) {
     const dir = proc[i]
     try {
+      // Piggyback on internal datastructures for control processes to see the git repo info
       const environData = readFileSync(path.join(`/proc`, dir, `environ`))
         ?.toString(`utf8`)
         ?.split(/\0/)