Add notes about thread blocking

Author: vignesh-sankaran

src/git.rs

@@ -124,13 +124,14 @@ pub fn yank(app: &App, krate: &str, version: &semver::Version, yanked: bool) ->
 /// being pushed.
 ///
 /// A maximum of 20 attempts to commit and push to the index currently
-/// accounts for the amount of traffic publishing crates, though this will
-/// eventually need to be changed past a certain point.
+/// accounts for the amount of traffic publishing crates, though this may 
+/// have to be changed in the future.
 ///
 /// Notes:
-/// Currently, this function is called from the HTTP thread and is blocking.
-/// This could be changed to run from a different thread and use a callback
-/// upon completion to the HTTP thread.
+/// Currently, this function is called on the HTTP thread and is blocking.
+/// Spawning a separate thread for this function means that the request
+/// can return without waiting for completion, and other methods of
+/// notifying upon completion or error can be used.
 fn commit_and_push<F>(repo: &git2::Repository, mut f: F) -> CargoResult<()>
 where
     F: FnMut() -> CargoResult<(String, PathBuf)>,

src/krate.rs

@@ -1124,6 +1124,10 @@ pub fn show(req: &mut Request) -> CargoResult<Response> {
 /// Handles the `PUT /crates/new` route.
 /// Used by `cargo publish` to publish a new crate or to publish a new version of an
 /// existing crate.
+///
+/// Currently blocks the HTTP thread, perhaps some function calls can spawn new
+/// threads and return completion or error through other methods  a `cargo publish
+/// --status` command, via crates.io's front end, or email.
 pub fn new(req: &mut Request) -> CargoResult<Response> {
     let app = req.app().clone();
     let (new_crate, user) = parse_new_headers(req)?;